Class AssignServerInstance
Defined in File ServerInstance.h
Page Contents
Inheritance Relationships
Base Type
public axr::sdk::Object
(Class Object)
Class Documentation
-
class AssignServerInstance : public axr::sdk::Object
Describes a request to assign a new server instance for a given session.
- Author
Jean-Philippe Steinmetz info@acceleratxr.com
Public Functions
-
inline AssignServerInstance()
-
inline AssignServerInstance(const AssignServerInstance &value)
-
inline AssignServerInstance(AssignServerInstance &&value)
-
inline virtual ~AssignServerInstance()
-
inline virtual AssignServerInstance &SetProperties(const std::map<utility::string_t, Variant> &value) override
Sets the object’s underlying map of stored values.
-
inline virtual AssignServerInstance &SetProperties(std::map<utility::string_t, Variant> &&value) override
Sets the underlying map of stored values for the object.
-
inline virtual AssignServerInstance &SetProperty(const utility::char_t *name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual AssignServerInstance &SetProperty(const utility::string_t &name, const Variant &value) override
Sets the property of the given name to the provided value.
-
utility::string_t GetAssignmentId() const
The UUID of the Session or Shard to request a server instance for. Values should be encoded with the object type followed by a colon and then the UUID (e.g.
session:00000000-0000-0000-0000-000000000000
). Accepted value types aresession
andshard
.
-
AssignServerInstance &SetAssignmentId(const utility::string_t &value)
The UUID of the Session or Shard to request a server instance for. Values should be encoded with the object type followed by a colon and then the UUID (e.g.
session:00000000-0000-0000-0000-000000000000
). Accepted value types aresession
andshard
.- Parameters
value – The value to set.
-
utility::string_t GetBuildVersion() const
The build version of the server instance desired.
-
AssignServerInstance &SetBuildVersion(const utility::string_t &value)
The build version of the server instance desired.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetInitOptions() const
A list of options that the server instance should initialize itself with.
-
AssignServerInstance &SetInitOptions(std::vector<utility::string_t> value)
A list of options that the server instance should initialize itself with.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetRegions() const
The list of preferred server regions, in order from most desirable to least.
-
AssignServerInstance &SetRegions(std::vector<utility::string_t> value)
The list of preferred server regions, in order from most desirable to least.
- Parameters
value – The value to set.
-
std::vector<utility::string_t> GetTags() const
A list of descriptive labels that the requested server must have.
-
AssignServerInstance &SetTags(std::vector<utility::string_t> value)
A list of descriptive labels that the requested server must have.
- Parameters
value – The value to set.