Class Backup

Class Backup#

Inheritance Relationships#

Base Type#

Class Documentation#

class Backup : public xbe::sdk::EntityBase#

Describes a single backup job to be executed immediately or on a schedule.

REQUIRES: Backup Services

Author

Jean-Philippe Steinmetz xbe@xsolla.com

Public Functions

inline Backup()#
inline Backup(const Backup &value)#
inline Backup(Backup &&value)#
inline virtual ~Backup()#
inline virtual Backup &SetProperties(const std::map<utility::string_t, Variant> &value) override#

Sets the object’s underlying map of stored values.

inline virtual Backup &SetProperties(std::map<utility::string_t, Variant> &&value) override#

Sets the underlying map of stored values for the object.

inline virtual Backup &SetProperty(const utility::char_t *name, const Variant &value) override#

Sets the property of the given name to the provided value.

inline virtual Backup &SetProperty(const utility::string_t &name, const Variant &value) override#

Sets the property of the given name to the provided value.

inline virtual Backup &SetRemoteUrl(const utility::string_t &url) override#

Returns the URL of the remote server endpoint where the object is managed.

inline virtual Backup &SetUid(const utility::string_t &value) override#

Sets the value of the Uid property.

Parameters:

value – The value to set.

inline virtual Backup &SetDateCreated(const datetime &value) override#

Sets the value of the DateCreated property.

Parameters:

value – The value to set.

inline virtual Backup &SetDateModified(const datetime &value) override#

Sets the value of the DateModified property.

Parameters:

value – The value to set.

inline virtual Backup &SetVersion(const uint64_t value) override#

Sets the value of the Version property.

Parameters:

value – The value to set.

virtual void Validate() override#
bool IsActive() const#

Indicates whether the backup job is currently active and will be executed.

Backup &SetActive(bool value)#

Indicates whether the backup job is currently active and will be executed.

Parameters:

value – The value to set.

utility::string_t GetName() const#

The unique name of the backup job.

Backup &SetName(const utility::string_t &value)#

The unique name of the backup job.

Parameters:

value – The value to set.

utility::string_t GetDescription() const#

A textual description of the backup job.

Backup &SetDescription(const utility::string_t &value)#

A textual description of the backup job.

Parameters:

value – The value to set.

std::vector<utility::string_t> GetEvents() const#

The list of event messages that occurred during the last job execution.

Backup &SetEvents(std::vector<utility::string_t> value)#

The list of event messages that occurred during the last job execution.

Parameters:

value – The value to set.

std::uint64_t GetKeep() const#

The total number of snapshots for this job to retain.

Backup &SetKeep(std::uint64_t value)#

The total number of snapshots for this job to retain.

Parameters:

value – The value to set.

utility::string_t GetSchedule() const#

The cron-tab style schedule of how often the job will execute. If set to null this job executes exactly once.

Backup &SetSchedule(const utility::string_t &value)#

The cron-tab style schedule of how often the job will execute. If set to null this job executes exactly once.

Parameters:

value – The value to set.

const Status *GetStatus() const#

The current state of the backup job.

Backup &SetStatus(const Status *value)#

The current state of the backup job.

Parameters:

value – The value to set.

Public Static Functions

static inline const utility::char_t *ClassName()#

Returns the fully qualified name of the class.