RHAPI_InstanceInfoUpdate
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_InstanceInfoUpdate | A request body to update the instance resource in a session. |
struct FRHAPI_InstanceInfoUpdate
struct FRHAPI_InstanceInfoUpdate : public FRHAPI_ModelA request body to update the instance resource in a session.
Summary
| Members | Descriptions |
|---|---|
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. |
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const | Writes 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() 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. |
Members
public FString AllocationId_Optional
Allocation ID for instance that’s been spun up.
#### `public bool `[`AllocationId_IsSet`](#structFRHAPI__InstanceInfoUpdate_1ac508606b8473f2e8c181113f9854e38b)
true if AllocationId_Optional has been set to a value
#### `public ERHAPI_InstanceJoinableStatus `[`JoinStatus_Optional`](#structFRHAPI__InstanceInfoUpdate_1ac4dc17da51fdc32b763982c1ce5f2280)
Is the instance joinable at this time?
#### `public bool `[`JoinStatus_IsSet`](#structFRHAPI__InstanceInfoUpdate_1a58d43b5bcd88cb03d2947cbc05d281c3)
true if JoinStatus_Optional has been set to a value
#### `public `[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` `[`JoinParams_Optional`](#structFRHAPI__InstanceInfoUpdate_1a67e685eb7f2a83856062a62b1dd97f0f)
Parameters to join the instance.
#### `public bool `[`JoinParams_IsSet`](#structFRHAPI__InstanceInfoUpdate_1a282916807722278b12016aa1a3ed5b75)
true if JoinParams_Optional has been set to a value
#### `public FString `[`Version_Optional`](#structFRHAPI__InstanceInfoUpdate_1a35ab20e36eed28c547f90e48589061d2)
Product Client Version number. Used for compatibility checking with players. Must be compatible with all players to spawn.
#### `public bool `[`Version_IsSet`](#structFRHAPI__InstanceInfoUpdate_1a62dd84585fe7d789fd5d075e16cdf173)
true if Version_Optional has been set to a value
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__InstanceInfoUpdate_1a4f9df70e7dbb3fa7ad0267292d336c0c)
instance-defined custom data
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__InstanceInfoUpdate_1a512d5615df2069935e21dcad2a28a5b1)
true if CustomData_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__InstanceInfoUpdate_1a0025c9a5c68bb02a70d72b382f90e808)`(const TSharedPtr< FJsonValue > & JsonValue)`
Fills this object with data from the passed in JSON.
Parameters
JsonValueData from the API call.
Returns
true if parsing of the JSON data was successful.
#### `public virtual void `[`WriteJson`](#structFRHAPI__InstanceInfoUpdate_1a0df4b09d5e66ce21ba3d356167187988)`(TSharedRef< TJsonWriter<>> & Writer) const`
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
#### `public inline FString & `[`GetAllocationId`](#structFRHAPI__InstanceInfoUpdate_1a64ca602e321e6268806f53f3f6b155d9)`()`
Gets the value of AllocationId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetAllocationId`](#structFRHAPI__InstanceInfoUpdate_1a1855488f2050473f91d74efcae57bed5)`() const`
Gets the value of AllocationId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetAllocationId`](#structFRHAPI__InstanceInfoUpdate_1a2ec031eb287edf91d3d368facce386ae)`(const FString & DefaultValue) const`
Gets the value of AllocationId_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetAllocationId`](#structFRHAPI__InstanceInfoUpdate_1a07994c6bfe221b0139396d35ea2524bd)`(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`](#structFRHAPI__InstanceInfoUpdate_1ac7e5d963cf694411fa97370bab7fd105)`()`
Returns a pointer to AllocationId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetAllocationIdOrNull`](#structFRHAPI__InstanceInfoUpdate_1a2e799cd8e4de2ad2158b4159014981e8)`() const`
Returns a pointer to AllocationId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetAllocationId`](#structFRHAPI__InstanceInfoUpdate_1a5a7b9aa618594613f74b90010d75921c)`(FString NewValue)`
Sets the value of AllocationId_Optional and also sets AllocationId_IsSet to true.
#### `public inline void `[`ClearAllocationId`](#structFRHAPI__InstanceInfoUpdate_1a1ce0fdb8b13b7f7419efa864dfa511fd)`()`
Clears the value of AllocationId_Optional and sets AllocationId_IsSet to false.
#### `public inline ERHAPI_InstanceJoinableStatus & `[`GetJoinStatus`](#structFRHAPI__InstanceInfoUpdate_1af26c0ff01356cd92cb405e5e5119ddd5)`()`
Gets the value of JoinStatus_Optional, regardless of it having been set.
#### `public inline const ERHAPI_InstanceJoinableStatus & `[`GetJoinStatus`](#structFRHAPI__InstanceInfoUpdate_1ae8c051ffa53dec044bb02e3dac538266)`() const`
Gets the value of JoinStatus_Optional, regardless of it having been set.
#### `public inline const ERHAPI_InstanceJoinableStatus & `[`GetJoinStatus`](#structFRHAPI__InstanceInfoUpdate_1a76a9891d41efa118afccb361b07a9777)`(const ERHAPI_InstanceJoinableStatus & DefaultValue) const`
Gets the value of JoinStatus_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetJoinStatus`](#structFRHAPI__InstanceInfoUpdate_1a5e50e7754bc22d5df480bd2a9f0ac069)`(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`](#structFRHAPI__InstanceInfoUpdate_1aba0e628c51398992e3e63cc6f3c558f2)`()`
Returns a pointer to JoinStatus_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const ERHAPI_InstanceJoinableStatus * `[`GetJoinStatusOrNull`](#structFRHAPI__InstanceInfoUpdate_1ab5c85b18d1802ca34a71426c03a53bb0)`() const`
Returns a pointer to JoinStatus_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetJoinStatus`](#structFRHAPI__InstanceInfoUpdate_1a5a886ccf87785f0e43ed373e71660d0d)`(ERHAPI_InstanceJoinableStatus NewValue)`
Sets the value of JoinStatus_Optional and also sets JoinStatus_IsSet to true.
#### `public inline void `[`ClearJoinStatus`](#structFRHAPI__InstanceInfoUpdate_1a08d153a486e719dd86f7272688d3fd6f)`()`
Clears the value of JoinStatus_Optional and sets JoinStatus_IsSet to false.
#### `public inline `[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` & `[`GetJoinParams`](#structFRHAPI__InstanceInfoUpdate_1a03f21833b60e2badc19066337085d191)`()`
Gets the value of JoinParams_Optional, regardless of it having been set.
#### `public inline const `[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` & `[`GetJoinParams`](#structFRHAPI__InstanceInfoUpdate_1ac6ecb169546fa5747fbf8cd5c6235ef1)`() const`
Gets the value of JoinParams_Optional, regardless of it having been set.
#### `public inline const `[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` & `[`GetJoinParams`](#structFRHAPI__InstanceInfoUpdate_1a84ed81956f2e95b2da60e1890f2f5f2e)`(const `[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` & DefaultValue) const`
Gets the value of JoinParams_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetJoinParams`](#structFRHAPI__InstanceInfoUpdate_1a466aafbad25fa684d1e299f58b1da2dc)`(`[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__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`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` * `[`GetJoinParamsOrNull`](#structFRHAPI__InstanceInfoUpdate_1a7186ddbe2b8b25a854d4c204dc0d3ac4)`()`
Returns a pointer to JoinParams_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const `[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` * `[`GetJoinParamsOrNull`](#structFRHAPI__InstanceInfoUpdate_1ab4ac445de76a794db5dc4563eafd5c9d)`() const`
Returns a pointer to JoinParams_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetJoinParams`](#structFRHAPI__InstanceInfoUpdate_1ac1e9ab7f8cb494ef9102448e0e7d47d8)`(`[`FRHAPI_JoinParams`](RHAPI_JoinParams.md#structFRHAPI__JoinParams)` NewValue)`
Sets the value of JoinParams_Optional and also sets JoinParams_IsSet to true.
#### `public inline void `[`ClearJoinParams`](#structFRHAPI__InstanceInfoUpdate_1a8fb8d668734c8ac5966d242b3c45898d)`()`
Clears the value of JoinParams_Optional and sets JoinParams_IsSet to false.
#### `public inline FString & `[`GetVersion`](#structFRHAPI__InstanceInfoUpdate_1ac741a5b9562c6ea3923d85597957d049)`()`
Gets the value of Version_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetVersion`](#structFRHAPI__InstanceInfoUpdate_1abc3bccf52de4ef008ae2b16c979f307f)`() const`
Gets the value of Version_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetVersion`](#structFRHAPI__InstanceInfoUpdate_1a4affad8891171f8d8ea017130cbb48ce)`(const FString & DefaultValue) const`
Gets the value of Version_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetVersion`](#structFRHAPI__InstanceInfoUpdate_1af28a6083f3cc2ad98e633593379626c1)`(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`](#structFRHAPI__InstanceInfoUpdate_1ab352c47b6254e5799af38a5b9155c754)`()`
Returns a pointer to Version_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetVersionOrNull`](#structFRHAPI__InstanceInfoUpdate_1abd236ea838c0fa5073c1e37be9d9c88b)`() const`
Returns a pointer to Version_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetVersion`](#structFRHAPI__InstanceInfoUpdate_1a13ee65dc626609559990225eaea039cb)`(FString NewValue)`
Sets the value of Version_Optional and also sets Version_IsSet to true.
#### `public inline void `[`ClearVersion`](#structFRHAPI__InstanceInfoUpdate_1a38e9c831413bc30e6d00a4c6ce9930e9)`()`
Clears the value of Version_Optional and sets Version_IsSet to false.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceInfoUpdate_1a8951474053adf95b048a6f1a764caeda)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceInfoUpdate_1a8557aa13e510eaec0e7ff82d9035e73a)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceInfoUpdate_1aea3eabc61bba5bfdd6927739c893b722)`(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__InstanceInfoUpdate_1af24b253e7a5c9609319c6bfd9e647e4e)`(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__InstanceInfoUpdate_1a83765e6111181d99b031698eb52c26c2)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__InstanceInfoUpdate_1a245bd89b7ee39ab693fe85e93d233e7b)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__InstanceInfoUpdate_1a230e53d731b7b798baef4958e2ce7ae9)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__InstanceInfoUpdate_1a9b87f305257195c6b1f5f2e407e94ff4)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.