RHAPI_InstanceLaunchTemplate

Summary

Members	Descriptions
struct FRHAPI_InstanceLaunchTemplate	DEPRECATED 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

Members	Descriptions
public FGuid InstanceLaunchTemplateId	ID to uniquely identify this instance launch template.
public FRHAPI_MapSelectionList MapSelectionList	A selection list of maps that can be chosen to launch into.
public ERHAPI_HostType DefaultHostType	Default host type for this template. Can be overriden in instance requests.
public TMap< FString, FString > CustomData_Optional	Custom data that will be passed to the session during the instance launch request.
public bool CustomData_IsSet	true 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) const	Writes 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() const	Gets 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() const	Gets 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() const	Gets 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() const	Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(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(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()	Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() const	Returns 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 MapSelectionList

A selection list of maps that can be chosen to launch into.

public ERHAPI_HostType DefaultHostType

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

public TMap< FString, FString > CustomData_Optional

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

public bool CustomData_IsSet

true 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.

Parameters

• JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.

public virtual void WriteJson(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()

Gets the value of InstanceLaunchTemplateId.

public inline const FGuid & GetInstanceLaunchTemplateId() const

Gets 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() const

Gets 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() const

Gets 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() const

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

public inline const TMap< FString, FString > & GetCustomData(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(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()

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

public inline const TMap< FString, FString > * GetCustomDataOrNull() const

Returns 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.