Skip to main content

RHAPI_JoinParams

Summary​

MembersDescriptions
struct FRHAPI_JoinParamsParameters provided by the allocation system or an instance on how to connect.

struct FRHAPI_JoinParams ​

struct FRHAPI_JoinParams
  : public FRHAPI_Model

Parameters provided by the allocation system or an instance on how to connect.

Summary​

MembersDescriptions
public FString PublicConnStrPublic connection string for instance.
public FString PrivateConnStrPrivate connection string for instance.
public TMap< FString, FString > CustomData_OptionalCustom data to join a instance.
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 & GetPublicConnStr()Gets the value of PublicConnStr.
public inline const FString & GetPublicConnStr() constGets the value of PublicConnStr.
public inline void SetPublicConnStr(const FString & NewValue)Sets the value of PublicConnStr.
public inline void SetPublicConnStr(FString && NewValue)Sets the value of PublicConnStr using move semantics.
public inline FString & GetPrivateConnStr()Gets the value of PrivateConnStr.
public inline const FString & GetPrivateConnStr() constGets the value of PrivateConnStr.
public inline void SetPrivateConnStr(const FString & NewValue)Sets the value of PrivateConnStr.
public inline void SetPrivateConnStr(FString && NewValue)Sets the value of PrivateConnStr using move semantics.
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(const TMap< FString, FString > & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.

Members​

public FString PublicConnStr ​

Public connection string for instance.

public FString PrivateConnStr ​

Private connection string for instance.

public TMap< FString, FString > CustomData_Optional ​

Custom data to join a instance.

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 & GetPublicConnStr() ​

Gets the value of PublicConnStr.

public inline const FString & GetPublicConnStr() const ​

Gets the value of PublicConnStr.

public inline void SetPublicConnStr(const FString & NewValue) ​

Sets the value of PublicConnStr.

public inline void SetPublicConnStr(FString && NewValue) ​

Sets the value of PublicConnStr using move semantics.

public inline FString & GetPrivateConnStr() ​

Gets the value of PrivateConnStr.

public inline const FString & GetPrivateConnStr() const ​

Gets the value of PrivateConnStr.

public inline void SetPrivateConnStr(const FString & NewValue) ​

Sets the value of PrivateConnStr.

public inline void SetPrivateConnStr(FString && NewValue) ​

Sets the value of PrivateConnStr using move semantics.

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(const TMap< FString, FString > & NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(TMap< FString, FString > && NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.