Class AssetStorageLocation

Defined in File AssetStorageLocation.h

Page Contents

Inheritance Relationships
- Base Type
Class Documentation

Inheritance Relationships

Base Type

public axr::sdk::EntityBase (Class EntityBase)

Class Documentation

class AssetStorageLocation : public axr::sdk::EntityBase 

Defines a single location of remote storage that will be used to maintain assets.

Author: Jean-Philippe Steinmetz info@acceleratxr.com

Public Functions

inline AssetStorageLocation()

inline AssetStorageLocation(const AssetStorageLocation &value)

inline AssetStorageLocation(AssetStorageLocation &&value)

inline virtual ~AssetStorageLocation()

inline virtual AssetStorageLocation &SetProperties(const std::map<utility::string_t, Variant> &value) override: Sets the object’s underlying map of stored values.

inline virtual AssetStorageLocation &SetProperties(std::map<utility::string_t, Variant> &&value) override: Sets the underlying map of stored values for the object.

inline virtual AssetStorageLocation &SetProperty(const utility::char_t *name, const Variant &value) override: Sets the property of the given name to the provided value.

inline virtual AssetStorageLocation &SetProperty(const utility::string_t &name, const Variant &value) override: Sets the property of the given name to the provided value.

inline virtual AssetStorageLocation &SetRemoteUrl(const utility::string_t &url) override: Returns the URL of the remote server endpoint where the object is managed.

inline virtual AssetStorageLocation &SetUid(const utility::string_t &value) override

Sets the value of the Uid property.

Parameters: value – The value to set.

inline virtual AssetStorageLocation &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters: value – The value to set.

inline virtual AssetStorageLocation &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters: value – The value to set.

inline virtual AssetStorageLocation &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters: value – The value to set.

virtual void Validate() override

utility::string_t GetName() const: The unique name of the storage location.

AssetStorageLocation &SetName(const utility::string_t &value)

The unique name of the storage location.

Parameters: value – The value to set.

utility::string_t GetDescription() const: A textual description of the storage location.

AssetStorageLocation &SetDescription(const utility::string_t &value)

A textual description of the storage location.

Parameters: value – The value to set.

utility::string_t GetAccessKey() const: The API access key to authenticate with the remote server with.

AssetStorageLocation &SetAccessKey(const utility::string_t &value)

The API access key to authenticate with the remote server with.

Parameters: value – The value to set.

bool IsActive() const: Indicates if the storage location is currently active for storing assets. Default is true.

AssetStorageLocation &SetActive(bool value)

Indicates if the storage location is currently active for storing assets.

Parameters: value – The value to set.

utility::string_t GetBucket() const: The name of the remote storage bucket.

AssetStorageLocation &SetBucket(const utility::string_t &value)

The name of the remote storage bucket.

Parameters: value – The value to set.

std::vector<utility::string_t> GetExcludes() const: A list of regex patterns of asset names that will be ignored from being stored in this location.

AssetStorageLocation &SetExcludes(std::vector<utility::string_t> value)

A list of regex patterns of asset names that will be ignored from being stored in this location.

Parameters: value – The value to set.

utility::string_t GetHost() const: The host of the remote storage provider.

AssetStorageLocation &SetHost(const utility::string_t &value)

The host of the remote storage provider.

Parameters: value – The value to set.

std::vector<utility::string_t> GetIncludes() const: A list of regex patterns of asset names that will be stored in this location.

AssetStorageLocation &SetIncludes(std::vector<utility::string_t> value)

A list of regex patterns of asset names that will be stored in this location.

Parameters: value – The value to set.

std::shared_ptr<Object> GetOptions() const: Additional configuration options used by the storage provider.

AssetStorageLocation &SetOptions(std::shared_ptr<Object> value)

Additional configuration options used by the storage provider.

Parameters: value – The value to set.

utility::string_t GetPath() const: The path prefix or sub-directory to store files.

AssetStorageLocation &SetPath(const utility::string_t &value)

The path prefix or sub-directory to store files.

Parameters: value – The value to set.

const StorageProvider *GetProvider() const: Describes the provider type of storage location.

AssetStorageLocation &SetProvider(const StorageProvider *value)

Describes the provider type of storage location.

Parameters: value – The value to set.

utility::string_t GetRegion() const: The region that the bucket is located in. Note this is not supported by all providers.

AssetStorageLocation &SetRegion(const utility::string_t &value)

The region that the bucket is located in. Note this is not supported by all providers.

Parameters: value – The value to set.

utility::string_t GetSecret() const: The API secret to authenticate with the remote server with.

AssetStorageLocation &SetSecret(const utility::string_t &value)

The API secret to authenticate with the remote server with.

Parameters: value – The value to set.

utility::string_t GetUrl() const: The public base URL that assets stored in this location will use.

AssetStorageLocation &SetUrl(const utility::string_t &value)

The public base URL that assets stored in this location will use.

Parameters: value – The value to set.

Public Static Functions

static inline const utility::char_t *ClassName(): Returns the fully qualified name of the class.