Skip to content

RHAPI_InstanceLaunchTemplate

Summary

MembersDescriptions
struct FRHAPI_InstanceLaunchTemplateDEPRECATED Configuration about how an instance should behave when it’s allocated

struct FRHAPI_InstanceLaunchTemplate

struct FRHAPI_InstanceLaunchTemplate
: public FRHAPI_Model

DEPRECATED Configuration about how an instance should behave when it’s allocated

Summary

MembersDescriptions
public FGuid InstanceLaunchTemplateIdID to uniquely identify this instance launch template.
public FRHAPI_MapSelectionList MapSelectionList
public ERHAPI_HostType DefaultHostTypeDefault host type for this template. Can be overriden in instance requests.
public TMap< FString, FString > CustomData_OptionalCustom data that will be passed to the session during the instance launch request.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)Fills this object with data from the passed in JSON.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) constWrites the data from this object into the specified JSON Writer stream.
public inline FGuid & GetInstanceLaunchTemplateId()Gets the value of InstanceLaunchTemplateId.
public inline const FGuid & GetInstanceLaunchTemplateId() constGets the value of InstanceLaunchTemplateId.
public inline void SetInstanceLaunchTemplateId(FGuid NewValue)Sets the value of InstanceLaunchTemplateId.
public inline FRHAPI_MapSelectionList&GetMapSelectionList()Gets the value of MapSelectionList.
public inline const FRHAPI_MapSelectionList&GetMapSelectionList() constGets the value of MapSelectionList.
public inline void SetMapSelectionList(FRHAPI_MapSelectionList NewValue)Sets the value of MapSelectionList.
public inline ERHAPI_HostType & GetDefaultHostType()Gets the value of DefaultHostType.
public inline const ERHAPI_HostType & GetDefaultHostType() constGets the value of DefaultHostType.
public inline void SetDefaultHostType(ERHAPI_HostType NewValue)Sets the value of DefaultHostType.
public inline TMap< FString, FString > & GetCustomData()Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() constReturns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(TMap< FString, FString > NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

Members

public FGuid InstanceLaunchTemplateId

ID to uniquely identify this instance launch template.


#### `public `[`FRHAPI_MapSelectionList`](RHAPI_MapSelectionList.md#structFRHAPI__MapSelectionList)` `[`MapSelectionList`](#structFRHAPI__InstanceLaunchTemplate_1af18bdd7b827122711991ea24f173fc3b)
#### `public ERHAPI_HostType `[`DefaultHostType`](#structFRHAPI__InstanceLaunchTemplate_1a0b56b43efbfe4616f67e08338d568d47)

Default host type for this template. Can be overriden in instance requests.


#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__InstanceLaunchTemplate_1a6bf36189794fec0d38e69a55b4135363)

Custom data that will be passed to the session during the instance launch request.


#### `public bool `[`CustomData_IsSet`](#structFRHAPI__InstanceLaunchTemplate_1a364303f0bb7d6d6f0e90eb75c41ac937)

true if CustomData_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__InstanceLaunchTemplate_1a9c24a5ea21de69f9bcd65c73f4d15559)`(const TSharedPtr< FJsonValue > & JsonValue)`

Fills this object with data from the passed in JSON.

Parameters

  • JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.


#### `public virtual void `[`WriteJson`](#structFRHAPI__InstanceLaunchTemplate_1ad2fe1ba96c85828d23d5122a7cd2ce95)`(TSharedRef< TJsonWriter<>> & Writer) const`

Writes the data from this object into the specified JSON Writer stream.

Parameters

  • Writer JSON Writer stream to push .

#### `public inline FGuid & `[`GetInstanceLaunchTemplateId`](#structFRHAPI__InstanceLaunchTemplate_1a645feb373f0302fd43e3a4fded7a1d5d)`()`

Gets the value of InstanceLaunchTemplateId.


#### `public inline const FGuid & `[`GetInstanceLaunchTemplateId`](#structFRHAPI__InstanceLaunchTemplate_1a0b3842d18f16d2c94079fe0c93910c9b)`() const`

Gets the value of InstanceLaunchTemplateId.


#### `public inline void `[`SetInstanceLaunchTemplateId`](#structFRHAPI__InstanceLaunchTemplate_1a6fbb92a72bec4b09af929bb6cfc558e7)`(FGuid NewValue)`

Sets the value of InstanceLaunchTemplateId.


#### `public inline `[`FRHAPI_MapSelectionList`](RHAPI_MapSelectionList.md#structFRHAPI__MapSelectionList)` & `[`GetMapSelectionList`](#structFRHAPI__InstanceLaunchTemplate_1a7550e10953986adf59b249efe55848e8)`()`

Gets the value of MapSelectionList.


#### `public inline const `[`FRHAPI_MapSelectionList`](RHAPI_MapSelectionList.md#structFRHAPI__MapSelectionList)` & `[`GetMapSelectionList`](#structFRHAPI__InstanceLaunchTemplate_1aa358f8b3bdfe50ab77dc10791c9cfc81)`() const`

Gets the value of MapSelectionList.


#### `public inline void `[`SetMapSelectionList`](#structFRHAPI__InstanceLaunchTemplate_1af7f9a8e490e1a024a14c0e988744e153)`(`[`FRHAPI_MapSelectionList`](RHAPI_MapSelectionList.md#structFRHAPI__MapSelectionList)` NewValue)`

Sets the value of MapSelectionList.


#### `public inline ERHAPI_HostType & `[`GetDefaultHostType`](#structFRHAPI__InstanceLaunchTemplate_1a0b5d674190d7d7f9739caa2990c653cc)`()`

Gets the value of DefaultHostType.


#### `public inline const ERHAPI_HostType & `[`GetDefaultHostType`](#structFRHAPI__InstanceLaunchTemplate_1af24572d24cc0ebacd287fed22c12ee89)`() const`

Gets the value of DefaultHostType.


#### `public inline void `[`SetDefaultHostType`](#structFRHAPI__InstanceLaunchTemplate_1ac7fce40f23fa5537211a45d747983bab)`(ERHAPI_HostType NewValue)`

Sets the value of DefaultHostType.


#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceLaunchTemplate_1a79ceedb163febc7aa6f5608a21ddd929)`()`

Gets the value of CustomData_Optional, regardless of it having been set.


#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceLaunchTemplate_1a8902d8a407b6707dddf0fdd0aded5da3)`() const`

Gets the value of CustomData_Optional, regardless of it having been set.


#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceLaunchTemplate_1ab08920d63cadb78bf49330841095f287)`(const TMap< FString, FString > & DefaultValue) const`

Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.


#### `public inline bool `[`GetCustomData`](#structFRHAPI__InstanceLaunchTemplate_1a2c4b1a89f7008b6a896f0b698ad16ec4)`(TMap< FString, FString > & OutValue) const`

Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.


#### `public inline TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__InstanceLaunchTemplate_1a0e5ae9617c084f743fa5b6df295d45b7)`()`

Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.


#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__InstanceLaunchTemplate_1a7861e6b2e56afe863cb1abe6fc848277)`() const`

Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.


#### `public inline void `[`SetCustomData`](#structFRHAPI__InstanceLaunchTemplate_1ad2e928208d7823bc216ce2c49a6c1b99)`(TMap< FString, FString > NewValue)`

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.


#### `public inline void `[`ClearCustomData`](#structFRHAPI__InstanceLaunchTemplate_1accf875216c04898f0a996ce52e838833)`()`

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.