Class ServerInstance
Defined in File ServerInstance.h
Page Contents
Nested Relationships
Nested Types
Inheritance Relationships
Base Type
public axr::sdk::EntityBase
(Class EntityBase)
Class Documentation
-
class ServerInstance : public axr::sdk::EntityBase
Describes a single server instance.
REQUIRES: Server Instance Services
- Author
Jean-Philippe Steinmetz info@acceleratxr.com
Public Functions
-
inline ServerInstance()
-
inline ServerInstance(const ServerInstance &value)
-
inline ServerInstance(ServerInstance &&value)
-
inline virtual ~ServerInstance()
-
inline virtual ServerInstance &SetProperties(const std::map<utility::string_t, Variant> &value) override
Sets the object’s underlying map of stored values.
-
inline virtual ServerInstance &SetProperties(std::map<utility::string_t, Variant> &&value) override
Sets the underlying map of stored values for the object.
-
inline virtual ServerInstance &SetProperty(const utility::char_t *name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual ServerInstance &SetProperty(const utility::string_t &name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual ServerInstance &SetRemoteUrl(const utility::string_t &url) override
Returns the URL of the remote server endpoint where the object is managed.
-
inline virtual ServerInstance &SetUid(const utility::string_t &value) override
Sets the value of the Uid property.
- Parameters
value – The value to set.
-
inline virtual ServerInstance &SetDateCreated(const datetime &value) override
Sets the value of the DateCreated property.
- Parameters
value – The value to set.
-
inline virtual ServerInstance &SetDateModified(const datetime &value) override
Sets the value of the DateModified property.
- Parameters
value – The value to set.
-
inline virtual ServerInstance &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 GetAssignmentId() const
The type and uid of the server’s assignment (e.g. Shard or Session). The value takes the format
[session|shard]:<uid>
(e.g.session:570d4dbe-4d57-4f80-aa74-4948248772a0
).
-
ServerInstance &SetAssignmentId(const utility::string_t &value)
The type and uid of the server’s assignment (e.g. Shard or Session). The value takes the format
[session|shard]:<uid>
(e.g.session:570d4dbe-4d57-4f80-aa74-4948248772a0
).- Parameters
value – The value to set.
-
utility::string_t GetBuildVersion() const
The build version of the server instance.
-
ServerInstance &SetBuildVersion(const utility::string_t &value)
The build version of the server instance.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetInitOptions() const
A list of options that the server will initialize itself with when a session is assigned.
-
ServerInstance &SetInitOptions(std::vector<utility::string_t> value)
A list of options that the server will initialize itself with when a session is assigned.
- Parameters
value – The value to set.
-
datetime GetLastHeartbeat() const
The date and time that the server instance last sent a heartbeat.
-
ServerInstance &SetLastHeartbeat(const datetime value)
The uid of the user that created and owns ther server instance.
- Parameters
value – The value to set.
-
utility::string_t GetOwnerUid() const
The uid of the product that this server is associated with.
-
ServerInstance &SetOwnerUid(const utility::string_t &value)
The uid of the product that this server is associated with.
- Parameters
value – The value to set.
-
utility::string_t GetRegion() const
The name of the region that the server instance is running in.
-
ServerInstance &SetRegion(const utility::string_t &value)
The name of the region that the server instance is running in.
- Parameters
value – The value to set.
-
utility::string_t GetProductUid() const
The uid of the product that this server is associated with.
REQUIRES: Server Instance Services Studio.
-
ServerInstance &SetProductUid(const utility::string_t &value)
The uid of the product that this server is associated with.
REQUIRES: Server Instance Services Studio.
- Parameters
value – The value to set.
-
ServerInstance &SetStatus(const Status *value)
The current runtime status of the server instance.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetTags() const
A list of descriptive labels associated with the server.
-
ServerInstance &SetTags(std::vector<utility::string_t> value)
A list of descriptive labels associated with the server.
- Parameters
value – The value to set.
-
utility::string_t GetURL() const
The URL that clients use to establish a connection to the server.
-
ServerInstance &SetURL(const utility::string_t &value)
The URL that clients use to establish a connection to the server.
- Parameters
value – The value to set.
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>
Describes the current runtime status of a given server instance.