Skip to content

RHAPI_InstanceInfoUpdate

Summary

MembersDescriptions
struct FRHAPI_InstanceInfoUpdateA request body to update the instance resource in a session.

struct FRHAPI_InstanceInfoUpdate

struct FRHAPI_InstanceInfoUpdate
: public FRHAPI_Model

A request body to update the instance resource in a session.

Summary

MembersDescriptions
public FString AllocationId_OptionalAllocation ID for instance that’s been spun up.
public bool AllocationId_IsSettrue if AllocationId_Optional has been set to a value
public ERHAPI_InstanceJoinableStatus JoinStatus_OptionalIs the instance joinable at this time?
public bool JoinStatus_IsSettrue if JoinStatus_Optional has been set to a value
public FRHAPI_JoinParams JoinParams_OptionalParameters to join the instance.
public bool JoinParams_IsSettrue if JoinParams_Optional has been set to a value
public FString Version_OptionalProduct Client Version number. Used for compatibility checking with players. Must be compatible with all players to spawn.
public bool Version_IsSettrue if Version_Optional has been set to a value
public TMap< FString, FString > CustomData_Optionalinstance-defined custom data
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 FString & GetAllocationId()Gets the value of AllocationId_Optional, regardless of it having been set.
public inline const FString & GetAllocationId() constGets the value of AllocationId_Optional, regardless of it having been set.
public inline const FString & GetAllocationId(const FString & DefaultValue) constGets the value of AllocationId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetAllocationId(FString & OutValue) constFills OutValue with the value of AllocationId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetAllocationIdOrNull()Returns a pointer to AllocationId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetAllocationIdOrNull() constReturns a pointer to AllocationId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetAllocationId(FString NewValue)Sets the value of AllocationId_Optional and also sets AllocationId_IsSet to true.
public inline void ClearAllocationId()Clears the value of AllocationId_Optional and sets AllocationId_IsSet to false.
public inline ERHAPI_InstanceJoinableStatus & GetJoinStatus()Gets the value of JoinStatus_Optional, regardless of it having been set.
public inline const ERHAPI_InstanceJoinableStatus & GetJoinStatus() constGets the value of JoinStatus_Optional, regardless of it having been set.
public inline const ERHAPI_InstanceJoinableStatus & GetJoinStatus(const ERHAPI_InstanceJoinableStatus & DefaultValue) constGets the value of JoinStatus_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetJoinStatus(ERHAPI_InstanceJoinableStatus & OutValue) constFills OutValue with the value of JoinStatus_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_InstanceJoinableStatus * GetJoinStatusOrNull()Returns a pointer to JoinStatus_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_InstanceJoinableStatus * GetJoinStatusOrNull() constReturns a pointer to JoinStatus_Optional, if it has been set, otherwise returns nullptr.
public inline void SetJoinStatus(ERHAPI_InstanceJoinableStatus NewValue)Sets the value of JoinStatus_Optional and also sets JoinStatus_IsSet to true.
public inline void ClearJoinStatus()Clears the value of JoinStatus_Optional and sets JoinStatus_IsSet to false.
public inline FRHAPI_JoinParams&GetJoinParams()Gets the value of JoinParams_Optional, regardless of it having been set.
public inline const FRHAPI_JoinParams&GetJoinParams() constGets the value of JoinParams_Optional, regardless of it having been set.
public inline const FRHAPI_JoinParams&GetJoinParams(const FRHAPI_JoinParams & DefaultValue) constGets the value of JoinParams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetJoinParams(FRHAPI_JoinParams & OutValue) constFills OutValue with the value of JoinParams_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_JoinParams*GetJoinParamsOrNull()Returns a pointer to JoinParams_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_JoinParams*GetJoinParamsOrNull() constReturns a pointer to JoinParams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetJoinParams(FRHAPI_JoinParams NewValue)Sets the value of JoinParams_Optional and also sets JoinParams_IsSet to true.
public inline void ClearJoinParams()Clears the value of JoinParams_Optional and sets JoinParams_IsSet to false.
public inline FString & GetVersion()Gets the value of Version_Optional, regardless of it having been set.
public inline const FString & GetVersion() constGets the value of Version_Optional, regardless of it having been set.
public inline const FString & GetVersion(const FString & DefaultValue) constGets the value of Version_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetVersion(FString & OutValue) constFills OutValue with the value of Version_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetVersionOrNull()Returns a pointer to Version_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetVersionOrNull() constReturns a pointer to Version_Optional, if it has been set, otherwise returns nullptr.
public inline void SetVersion(FString NewValue)Sets the value of Version_Optional and also sets Version_IsSet to true.
public inline void ClearVersion()Clears the value of Version_Optional and sets Version_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() 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 FString AllocationId_Optional

Allocation ID for instance that’s been spun up.

public bool AllocationId_IsSet

true if AllocationId_Optional has been set to a value

public ERHAPI_InstanceJoinableStatus JoinStatus_Optional

Is the instance joinable at this time?

public bool JoinStatus_IsSet

true if JoinStatus_Optional has been set to a value

public FRHAPI_JoinParams JoinParams_Optional

Parameters to join the instance.

public bool JoinParams_IsSet

true if JoinParams_Optional has been set to a value

public FString Version_Optional

Product Client Version number. Used for compatibility checking with players. Must be compatible with all players to spawn.

public bool Version_IsSet

true if Version_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 & GetAllocationId()

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

public inline const FString & GetAllocationId() const

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

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

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

public inline bool GetAllocationId(FString & OutValue) const

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

public inline FString * GetAllocationIdOrNull()

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

public inline const FString * GetAllocationIdOrNull() const

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

public inline void SetAllocationId(FString NewValue)

Sets the value of AllocationId_Optional and also sets AllocationId_IsSet to true.

public inline void ClearAllocationId()

Clears the value of AllocationId_Optional and sets AllocationId_IsSet to false.

public inline ERHAPI_InstanceJoinableStatus & GetJoinStatus()

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

public inline const ERHAPI_InstanceJoinableStatus & GetJoinStatus() const

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

public inline const ERHAPI_InstanceJoinableStatus & GetJoinStatus(const ERHAPI_InstanceJoinableStatus & DefaultValue) const

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

public inline bool GetJoinStatus(ERHAPI_InstanceJoinableStatus & OutValue) const

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

public inline ERHAPI_InstanceJoinableStatus * GetJoinStatusOrNull()

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

public inline const ERHAPI_InstanceJoinableStatus * GetJoinStatusOrNull() const

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

public inline void SetJoinStatus(ERHAPI_InstanceJoinableStatus NewValue)

Sets the value of JoinStatus_Optional and also sets JoinStatus_IsSet to true.

public inline void ClearJoinStatus()

Clears the value of JoinStatus_Optional and sets JoinStatus_IsSet to false.

public inline FRHAPI_JoinParams&GetJoinParams()

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

public inline const FRHAPI_JoinParams&GetJoinParams() const

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

public inline const FRHAPI_JoinParams&GetJoinParams(const FRHAPI_JoinParams & DefaultValue) const

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

public inline bool GetJoinParams(FRHAPI_JoinParams & OutValue) const

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

public inline FRHAPI_JoinParams*GetJoinParamsOrNull()

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

public inline const FRHAPI_JoinParams*GetJoinParamsOrNull() const

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

public inline void SetJoinParams(FRHAPI_JoinParams NewValue)

Sets the value of JoinParams_Optional and also sets JoinParams_IsSet to true.

public inline void ClearJoinParams()

Clears the value of JoinParams_Optional and sets JoinParams_IsSet to false.

public inline FString & GetVersion()

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

public inline const FString & GetVersion() const

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

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

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

public inline bool GetVersion(FString & OutValue) const

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

public inline FString * GetVersionOrNull()

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

public inline const FString * GetVersionOrNull() const

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

public inline void SetVersion(FString NewValue)

Sets the value of Version_Optional and also sets Version_IsSet to true.

public inline void ClearVersion()

Clears the value of Version_Optional and sets Version_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.