RHAPI_InstanceFubar
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_InstanceFubar | Information about an instance that has been determined to be FUBAR. |
struct FRHAPI_InstanceFubar
struct FRHAPI_InstanceFubar
: public FRHAPI_Model
Information about an instance that has been determined to be FUBAR.
Summary
| Members | Descriptions |
|---|---|
public FString InstanceId | ID for which instance was marked as FUBAR. |
public FString Error | Error string describing what caused the instance failure. |
public FString Region | What region the failed instance was in. |
public FString MatchmakingProfileId_Optional | ID for which matchmaking profile was used to generate the failed instance. |
public bool MatchmakingProfileId_IsSet | true if MatchmakingProfileId_Optional has been set to a value |
public ERHAPI_InstanceSourceProvider InstanceSourceProvider_Optional | Which instance provider allocated this failed instance. |
public bool InstanceSourceProvider_IsSet | true if InstanceSourceProvider_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. |
public inline const FString & GetInstanceId() const | Gets the value of InstanceId. |
public inline void SetInstanceId(FString NewValue) | Sets the value of InstanceId. |
public inline FString & GetError() | Gets the value of Error. |
public inline const FString & GetError() const | Gets the value of Error. |
public inline void SetError(FString NewValue) | Sets the value of Error. |
public inline FString & GetRegion() | Gets the value of Region. |
public inline const FString & GetRegion() const | Gets the value of Region. |
public inline void SetRegion(FString NewValue) | Sets the value of Region. |
public inline FString & GetMatchmakingProfileId() | Gets the value of MatchmakingProfileId_Optional, regardless of it having been set. |
public inline const FString & GetMatchmakingProfileId() const | Gets the value of MatchmakingProfileId_Optional, regardless of it having been set. |
public inline const FString & GetMatchmakingProfileId(const FString & DefaultValue) const | Gets the value of MatchmakingProfileId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMatchmakingProfileId(FString & OutValue) const | Fills OutValue with the value of MatchmakingProfileId_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetMatchmakingProfileIdOrNull() | Returns a pointer to MatchmakingProfileId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetMatchmakingProfileIdOrNull() const | Returns a pointer to MatchmakingProfileId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMatchmakingProfileId(FString NewValue) | Sets the value of MatchmakingProfileId_Optional and also sets MatchmakingProfileId_IsSet to true. |
public inline void ClearMatchmakingProfileId() | Clears the value of MatchmakingProfileId_Optional and sets MatchmakingProfileId_IsSet to false. |
public inline ERHAPI_InstanceSourceProvider & GetInstanceSourceProvider() | Gets the value of InstanceSourceProvider_Optional, regardless of it having been set. |
public inline const ERHAPI_InstanceSourceProvider & GetInstanceSourceProvider() const | Gets the value of InstanceSourceProvider_Optional, regardless of it having been set. |
public inline const ERHAPI_InstanceSourceProvider & GetInstanceSourceProvider(const ERHAPI_InstanceSourceProvider & DefaultValue) const | Gets the value of InstanceSourceProvider_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetInstanceSourceProvider(ERHAPI_InstanceSourceProvider & OutValue) const | Fills OutValue with the value of InstanceSourceProvider_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_InstanceSourceProvider * GetInstanceSourceProviderOrNull() | Returns a pointer to InstanceSourceProvider_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_InstanceSourceProvider * GetInstanceSourceProviderOrNull() const | Returns a pointer to InstanceSourceProvider_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetInstanceSourceProvider(ERHAPI_InstanceSourceProvider NewValue) | Sets the value of InstanceSourceProvider_Optional and also sets InstanceSourceProvider_IsSet to true. |
public inline void ClearInstanceSourceProvider() | Clears the value of InstanceSourceProvider_Optional and sets InstanceSourceProvider_IsSet to false. |
Members
public FString InstanceId
ID for which instance was marked as FUBAR.
public FString Error
Error string describing what caused the instance failure.
public FString Region
What region the failed instance was in.
public FString MatchmakingProfileId_Optional
ID for which matchmaking profile was used to generate the failed instance.
public bool MatchmakingProfileId_IsSet
true if MatchmakingProfileId_Optional has been set to a value
public ERHAPI_InstanceSourceProvider InstanceSourceProvider_Optional
Which instance provider allocated this failed instance.
public bool InstanceSourceProvider_IsSet
true if InstanceSourceProvider_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
JsonValueData 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
WriterJSON Writer stream to push .
public inline FString & GetInstanceId()
Gets the value of InstanceId.
public inline const FString & GetInstanceId() const
Gets the value of InstanceId.
public inline void SetInstanceId(FString NewValue)
Sets the value of InstanceId.
public inline FString & GetError()
Gets the value of Error.
public inline const FString & GetError() const
Gets the value of Error.
public inline void SetError(FString NewValue)
Sets the value of Error.
public inline FString & GetRegion()
Gets the value of Region.
public inline const FString & GetRegion() const
Gets the value of Region.
public inline void SetRegion(FString NewValue)
Sets the value of Region.
public inline FString & GetMatchmakingProfileId()
Gets the value of MatchmakingProfileId_Optional, regardless of it having been set.
public inline const FString & GetMatchmakingProfileId() const
Gets the value of MatchmakingProfileId_Optional, regardless of it having been set.
public inline const FString & GetMatchmakingProfileId(const FString & DefaultValue) const
Gets the value of MatchmakingProfileId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMatchmakingProfileId(FString & OutValue) const
Fills OutValue with the value of MatchmakingProfileId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetMatchmakingProfileIdOrNull()
Returns a pointer to MatchmakingProfileId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetMatchmakingProfileIdOrNull() const
Returns a pointer to MatchmakingProfileId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMatchmakingProfileId(FString NewValue)
Sets the value of MatchmakingProfileId_Optional and also sets MatchmakingProfileId_IsSet to true.
public inline void ClearMatchmakingProfileId()
Clears the value of MatchmakingProfileId_Optional and sets MatchmakingProfileId_IsSet to false.
public inline ERHAPI_InstanceSourceProvider & GetInstanceSourceProvider()
Gets the value of InstanceSourceProvider_Optional, regardless of it having been set.
public inline const ERHAPI_InstanceSourceProvider & GetInstanceSourceProvider() const
Gets the value of InstanceSourceProvider_Optional, regardless of it having been set.
public inline const ERHAPI_InstanceSourceProvider & GetInstanceSourceProvider(const ERHAPI_InstanceSourceProvider & DefaultValue) const
Gets the value of InstanceSourceProvider_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceSourceProvider(ERHAPI_InstanceSourceProvider & OutValue) const
Fills OutValue with the value of InstanceSourceProvider_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_InstanceSourceProvider * GetInstanceSourceProviderOrNull()
Returns a pointer to InstanceSourceProvider_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_InstanceSourceProvider * GetInstanceSourceProviderOrNull() const
Returns a pointer to InstanceSourceProvider_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceSourceProvider(ERHAPI_InstanceSourceProvider NewValue)
Sets the value of InstanceSourceProvider_Optional and also sets InstanceSourceProvider_IsSet to true.
public inline void ClearInstanceSourceProvider()
Clears the value of InstanceSourceProvider_Optional and sets InstanceSourceProvider_IsSet to false.