RHAPI_InstanceRequest

Summary

Members	Descriptions
struct FRHAPI_InstanceRequest	A request body to create an instance resource in a session.

struct FRHAPI_InstanceRequest

struct FRHAPI_InstanceRequest
  : public FRHAPI_Model

A request body to create an instance resource in a session.

Summary

Members	Descriptions
public FString InstanceId_Optional	Unique ID for the instance, a new one will be generated if not provided.
public bool InstanceId_IsSet	true if InstanceId_Optional has been set to a value
public FRHAPI_InstanceStartupParams InstanceStartupParams_Optional
public bool InstanceStartupParams_IsSet	true if InstanceStartupParams_Optional has been set to a value
public ERHAPI_HostType HostType	Type of the host.
public FGuid HostPlayerUuid_Optional	Player UUID of the host, if the host type is player.
public bool HostPlayerUuid_IsSet	true if HostPlayerUuid_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	instance-defined custom data
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 FString & GetInstanceId()	Gets the value of InstanceId_Optional, regardless of it having been set.
public inline const FString & GetInstanceId() const	Gets the value of InstanceId_Optional, regardless of it having been set.
public inline const FString & GetInstanceId(const FString & DefaultValue) const	Gets the value of InstanceId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceId(FString & OutValue) const	Fills OutValue with the value of InstanceId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetInstanceIdOrNull()	Returns a pointer to InstanceId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetInstanceIdOrNull() const	Returns a pointer to InstanceId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceId(FString NewValue)	Sets the value of InstanceId_Optional and also sets InstanceId_IsSet to true.
public inline void ClearInstanceId()	Clears the value of InstanceId_Optional and sets InstanceId_IsSet to false.
public inline FRHAPI_InstanceStartupParams&GetInstanceStartupParams()	Gets the value of InstanceStartupParams_Optional, regardless of it having been set.
public inline const FRHAPI_InstanceStartupParams&GetInstanceStartupParams() const	Gets the value of InstanceStartupParams_Optional, regardless of it having been set.
public inline const FRHAPI_InstanceStartupParams&GetInstanceStartupParams(const FRHAPI_InstanceStartupParams & DefaultValue) const	Gets the value of InstanceStartupParams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceStartupParams(FRHAPI_InstanceStartupParams & OutValue) const	Fills OutValue with the value of InstanceStartupParams_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_InstanceStartupParams*GetInstanceStartupParamsOrNull()	Returns a pointer to InstanceStartupParams_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_InstanceStartupParams*GetInstanceStartupParamsOrNull() const	Returns a pointer to InstanceStartupParams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceStartupParams(FRHAPI_InstanceStartupParams NewValue)	Sets the value of InstanceStartupParams_Optional and also sets InstanceStartupParams_IsSet to true.
public inline void ClearInstanceStartupParams()	Clears the value of InstanceStartupParams_Optional and sets InstanceStartupParams_IsSet to false.
public inline ERHAPI_HostType & GetHostType()	Gets the value of HostType.
public inline const ERHAPI_HostType & GetHostType() const	Gets the value of HostType.
public inline void SetHostType(ERHAPI_HostType NewValue)	Sets the value of HostType.
public inline FGuid & GetHostPlayerUuid()	Gets the value of HostPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetHostPlayerUuid() const	Gets the value of HostPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetHostPlayerUuid(const FGuid & DefaultValue) const	Gets the value of HostPlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetHostPlayerUuid(FGuid & OutValue) const	Fills OutValue with the value of HostPlayerUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetHostPlayerUuidOrNull()	Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetHostPlayerUuidOrNull() const	Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetHostPlayerUuid(FGuid NewValue)	Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true.
public inline void ClearHostPlayerUuid()	Clears the value of HostPlayerUuid_Optional and sets HostPlayerUuid_IsSet to false.
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 FString InstanceId_Optional

Unique ID for the instance, a new one will be generated if not provided.

public bool InstanceId_IsSet

true if InstanceId_Optional has been set to a value

public FRHAPI_InstanceStartupParams InstanceStartupParams_Optional

public bool InstanceStartupParams_IsSet

true if InstanceStartupParams_Optional has been set to a value

public ERHAPI_HostType HostType

Type of the host.

public FGuid HostPlayerUuid_Optional

Player UUID of the host, if the host type is player.

public bool HostPlayerUuid_IsSet

true if HostPlayerUuid_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

instance-defined custom data

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 FString & GetInstanceId()

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

public inline const FString & GetInstanceId() const

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

public inline const FString & GetInstanceId(const FString & DefaultValue) const

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

public inline bool GetInstanceId(FString & OutValue) const

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

public inline FString * GetInstanceIdOrNull()

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

public inline const FString * GetInstanceIdOrNull() const

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

public inline void SetInstanceId(FString NewValue)

Sets the value of InstanceId_Optional and also sets InstanceId_IsSet to true.

public inline void ClearInstanceId()

Clears the value of InstanceId_Optional and sets InstanceId_IsSet to false.

public inline FRHAPI_InstanceStartupParams&GetInstanceStartupParams()

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

public inline const FRHAPI_InstanceStartupParams&GetInstanceStartupParams() const

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

public inline const FRHAPI_InstanceStartupParams&GetInstanceStartupParams(const FRHAPI_InstanceStartupParams & DefaultValue) const

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

public inline bool GetInstanceStartupParams(FRHAPI_InstanceStartupParams & OutValue) const

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

public inline FRHAPI_InstanceStartupParams*GetInstanceStartupParamsOrNull()

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

public inline const FRHAPI_InstanceStartupParams*GetInstanceStartupParamsOrNull() const

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

public inline void SetInstanceStartupParams(FRHAPI_InstanceStartupParams NewValue)

Sets the value of InstanceStartupParams_Optional and also sets InstanceStartupParams_IsSet to true.

public inline void ClearInstanceStartupParams()

Clears the value of InstanceStartupParams_Optional and sets InstanceStartupParams_IsSet to false.

public inline ERHAPI_HostType & GetHostType()

Gets the value of HostType.

public inline const ERHAPI_HostType & GetHostType() const

Gets the value of HostType.

public inline void SetHostType(ERHAPI_HostType NewValue)

Sets the value of HostType.

public inline FGuid & GetHostPlayerUuid()

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

public inline const FGuid & GetHostPlayerUuid() const

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

public inline const FGuid & GetHostPlayerUuid(const FGuid & DefaultValue) const

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

public inline bool GetHostPlayerUuid(FGuid & OutValue) const

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

public inline FGuid * GetHostPlayerUuidOrNull()

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

public inline const FGuid * GetHostPlayerUuidOrNull() const

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

public inline void SetHostPlayerUuid(FGuid NewValue)

Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true.

public inline void ClearHostPlayerUuid()

Clears the value of HostPlayerUuid_Optional and sets HostPlayerUuid_IsSet to false.

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.