Class BackupStorageLocation
Defined in File BackupStorageLocation.h
Page Contents
Inheritance Relationships
Base Type
public axr::sdk::EntityBase
(Class EntityBase)
Class Documentation
-
class BackupStorageLocation : public axr::sdk::EntityBase
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
Public Functions
-
inline BackupStorageLocation()
-
inline BackupStorageLocation(const BackupStorageLocation &value)
-
inline BackupStorageLocation(BackupStorageLocation &&value)
-
inline virtual ~BackupStorageLocation()
-
inline virtual BackupStorageLocation &SetProperties(const std::map<utility::string_t, Variant> &value) override
Sets the object’s underlying map of stored values.
-
inline virtual BackupStorageLocation &SetProperties(std::map<utility::string_t, Variant> &&value) override
Sets the underlying map of stored values for the object.
-
inline virtual BackupStorageLocation &SetProperty(const utility::char_t *name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual BackupStorageLocation &SetProperty(const utility::string_t &name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual BackupStorageLocation &SetRemoteUrl(const utility::string_t &url) override
Returns the URL of the remote server endpoint where the object is managed.
-
inline virtual BackupStorageLocation &SetUid(const utility::string_t &value) override
Sets the value of the Uid property.
- Parameters
value – The value to set.
-
inline virtual BackupStorageLocation &SetDateCreated(const datetime &value) override
Sets the value of the DateCreated property.
- Parameters
value – The value to set.
-
inline virtual BackupStorageLocation &SetDateModified(const datetime &value) override
Sets the value of the DateModified property.
- Parameters
value – The value to set.
-
inline virtual BackupStorageLocation &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.
-
BackupStorageLocation &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.
-
BackupStorageLocation &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.
-
BackupStorageLocation &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 backup location is currently active for storing database snapshots. An inactive location can still be used to search and retrieve existing snapshots.
-
BackupStorageLocation &SetActive(bool value)
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.
- Parameters
value – The value to set.
-
utility::string_t GetBucket() const
The name of the remote storage bucket.
-
BackupStorageLocation &SetBucket(const utility::string_t &value)
The name of the remote storage bucket.
- Parameters
value – The value to set.
-
utility::string_t GetHost() const
The host of the remote storage provider.
-
BackupStorageLocation &SetHost(const utility::string_t &value)
The host of the remote storage provider.
- Parameters
value – The value to set.
-
std::shared_ptr<Object> GetOptions() const
Additional configuration options used by the storage provider.
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.
-
BackupStorageLocation &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.
-
BackupStorageLocation &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.
-
BackupStorageLocation &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.
-
BackupStorageLocation &SetSecret(const utility::string_t &value)
The API secret to authenticate with the remote server with.
- Parameters
value – The value to set.
Public Static Functions
-
static inline const utility::char_t *ClassName()
Returns the fully qualified name of the class.