Class Shard
Defined in File Shard.h
Page Contents
Nested Relationships
Nested Types
Inheritance Relationships
Base Type
public axr::sdk::EntityBase(Class EntityBase)
Class Documentation
-
class Shard : public axr::sdk::EntityBase
Public Functions
-
inline Shard()
-
inline virtual ~Shard()
-
inline virtual Shard &SetProperties(const std::map<utility::string_t, Variant> &value) override
Sets the object’s underlying map of stored values.
-
inline virtual Shard &SetProperties(std::map<utility::string_t, Variant> &&value) override
Sets the underlying map of stored values for the object.
-
inline virtual Shard &SetProperty(const utility::char_t *name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual Shard &SetProperty(const utility::string_t &name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual Shard &SetRemoteUrl(const utility::string_t &url) override
Returns the URL of the remote server endpoint where the object is managed.
-
inline virtual Shard &SetUid(const utility::string_t &value) override
Sets the value of the Uid property.
- Parameters
value – The value to set.
-
inline virtual Shard &SetDateCreated(const datetime &value) override
Sets the value of the DateCreated property.
- Parameters
value – The value to set.
-
inline virtual Shard &SetDateModified(const datetime &value) override
Sets the value of the DateModified property.
- Parameters
value – The value to set.
-
inline virtual Shard &SetVersion(const uint64_t value) override
Sets the value of the Version property.
- Parameters
value – The value to set.
-
virtual void Validate() override
A map of arbitrary data.
- Parameters
value – The value to set.
-
datetime GetLastHeartbeat() const
The last time that the associated server instance made contact with the service.
-
Shard &SetLastHeartbeat(const datetime value)
The last time that the associated server instance made contact with the service.
-
int64_t GetMaxUsers() const
The maximum number of users that can join the shard.
-
Shard &SetMaxUsers(int64_t value)
The maximum number of users that can join the shard.
- Parameters
value – The value to set.
-
utility::string_t GetRegion() const
The name of the region that the associated server instance is running in.
-
Shard &SetRegion(const utility::string_t &value)
The name of the region that the associated server instance is running in.
- Parameters
value – The value to set.
-
const Status *GetStatus() const
Returns the value of the ServerStatus property as a utility::string_t.
-
Shard &SetStatus(const Status *value)
Sets the value of the ServerStatus property.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetTags() const
A list of descriptive labels that describes the shard, as inherited from the Zone.
-
Shard &SetTags(std::vector<utility::string_t> value)
A list of descriptive labels that describes the shard, as inherited from the Zone.
- Parameters
value – The value to set.
-
utility::string_t GetURL() const
The URL that players use to connect to the associated server instance.
-
Shard &SetURL(const utility::string_t &value)
The URL that players use to connect to the associated server instance.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetUsers() const
The list of user id’s that are joined to this shard.
-
Shard &SetUsers(std::vector<utility::string_t> value)
The list of user id’s that are joined to this shard.
- Parameters
value – The value to set.
-
utility::string_t GetZoneUid() const
Returns the value of the ZoneUid property as a utility::string_t.
Public Static Functions
-
static inline const utility::char_t *ClassName()
Returns the fully qualified name of the class.
-
class Status : public axr::sdk::StringEnum<Status>
-
inline Shard()