Skip to main content

RHAPI_KVsResponseV2

Summary​

MembersDescriptions
struct FRHAPI_KVsResponseV2

struct FRHAPI_KVsResponseV2 ​

struct FRHAPI_KVsResponseV2
  : public FRHAPI_Model

Summary​

MembersDescriptions
public TMap< FString, FString > Kvs_OptionalThe list of key/value pairs.
public bool Kvs_IsSettrue if Kvs_Optional has been set to a value
public TMap< FString, FString > SecretKvs_OptionalDEPRECATED The list of permissioned key/value pairs
public bool SecretKvs_IsSettrue if SecretKvs_Optional has been set to a value
public FDateTime KickBeforeHint_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool KickBeforeHint_IsSettrue if KickBeforeHint_Optional has been set to a value
public bool KickBeforeHint_IsNulltrue if KickBeforeHint_Optional has been explicitly set to null
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 TMap< FString, FString > & GetKvs()Gets the value of Kvs_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetKvs() constGets the value of Kvs_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetKvs(const TMap< FString, FString > & DefaultValue) constGets the value of Kvs_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetKvs(TMap< FString, FString > & OutValue) constFills OutValue with the value of Kvs_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetKvsOrNull()Returns a pointer to Kvs_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetKvsOrNull() constReturns a pointer to Kvs_Optional, if it has been set, otherwise returns nullptr.
public inline void SetKvs(const TMap< FString, FString > & NewValue)Sets the value of Kvs_Optional and also sets Kvs_IsSet to true.
public inline void SetKvs(TMap< FString, FString > && NewValue)Sets the value of Kvs_Optional and also sets Kvs_IsSet to true using move semantics.
public inline void ClearKvs()Clears the value of Kvs_Optional and sets Kvs_IsSet to false.
public inline bool IsKvsSet() constChecks whether Kvs_Optional has been set.
public inline TMap< FString, FString > & GetSecretKvs()Gets the value of SecretKvs_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetSecretKvs() constGets the value of SecretKvs_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetSecretKvs(const TMap< FString, FString > & DefaultValue) constGets the value of SecretKvs_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSecretKvs(TMap< FString, FString > & OutValue) constFills OutValue with the value of SecretKvs_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetSecretKvsOrNull()Returns a pointer to SecretKvs_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetSecretKvsOrNull() constReturns a pointer to SecretKvs_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSecretKvs(const TMap< FString, FString > & NewValue)Sets the value of SecretKvs_Optional and also sets SecretKvs_IsSet to true.
public inline void SetSecretKvs(TMap< FString, FString > && NewValue)Sets the value of SecretKvs_Optional and also sets SecretKvs_IsSet to true using move semantics.
public inline void ClearSecretKvs()Clears the value of SecretKvs_Optional and sets SecretKvs_IsSet to false.
public inline bool IsSecretKvsSet() constChecks whether SecretKvs_Optional has been set.
public inline FDateTime & GetKickBeforeHint()Gets the value of KickBeforeHint_Optional, regardless of it having been set.
public inline const FDateTime & GetKickBeforeHint() constGets the value of KickBeforeHint_Optional, regardless of it having been set.
public inline const FDateTime & GetKickBeforeHint(const FDateTime & DefaultValue) constGets the value of KickBeforeHint_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetKickBeforeHint(FDateTime & OutValue) constFills OutValue with the value of KickBeforeHint_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetKickBeforeHintOrNull()Returns a pointer to KickBeforeHint_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetKickBeforeHintOrNull() constReturns a pointer to KickBeforeHint_Optional, if it has been set, otherwise returns nullptr.
public inline void SetKickBeforeHint(const FDateTime & NewValue)Sets the value of KickBeforeHint_Optional and also sets KickBeforeHint_IsSet to true.
public inline void SetKickBeforeHint(FDateTime && NewValue)Sets the value of KickBeforeHint_Optional and also sets KickBeforeHint_IsSet to true using move semantics.
public inline void ClearKickBeforeHint()Clears the value of KickBeforeHint_Optional and sets KickBeforeHint_IsSet to false.
public inline bool IsKickBeforeHintSet() constChecks whether KickBeforeHint_Optional has been set.
public inline void SetKickBeforeHintToNull()Sets the value explicitly to be treated as null.
public inline bool IsKickBeforeHintNull() constChecks whether KickBeforeHint_Optional is set to null.

Members​

public TMap< FString, FString > Kvs_Optional ​

The list of key/value pairs.

public bool Kvs_IsSet ​

true if Kvs_Optional has been set to a value

public TMap< FString, FString > SecretKvs_Optional ​

DEPRECATED The list of permissioned key/value pairs

public bool SecretKvs_IsSet ​

true if SecretKvs_Optional has been set to a value

public FDateTime KickBeforeHint_Optional ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool KickBeforeHint_IsSet ​

true if KickBeforeHint_Optional has been set to a value

public bool KickBeforeHint_IsNull ​

true if KickBeforeHint_Optional has been explicitly set to null

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

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

public inline const TMap< FString, FString > & GetKvs() const ​

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

public inline const TMap< FString, FString > & GetKvs(const TMap< FString, FString > & DefaultValue) const ​

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

public inline bool GetKvs(TMap< FString, FString > & OutValue) const ​

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

public inline TMap< FString, FString > * GetKvsOrNull() ​

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

public inline const TMap< FString, FString > * GetKvsOrNull() const ​

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

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

Sets the value of Kvs_Optional and also sets Kvs_IsSet to true.

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

Sets the value of Kvs_Optional and also sets Kvs_IsSet to true using move semantics.

public inline void ClearKvs() ​

Clears the value of Kvs_Optional and sets Kvs_IsSet to false.

public inline bool IsKvsSet() const ​

Checks whether Kvs_Optional has been set.

public inline TMap< FString, FString > & GetSecretKvs() ​

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

public inline const TMap< FString, FString > & GetSecretKvs() const ​

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

public inline const TMap< FString, FString > & GetSecretKvs(const TMap< FString, FString > & DefaultValue) const ​

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

public inline bool GetSecretKvs(TMap< FString, FString > & OutValue) const ​

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

public inline TMap< FString, FString > * GetSecretKvsOrNull() ​

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

public inline const TMap< FString, FString > * GetSecretKvsOrNull() const ​

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

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

Sets the value of SecretKvs_Optional and also sets SecretKvs_IsSet to true.

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

Sets the value of SecretKvs_Optional and also sets SecretKvs_IsSet to true using move semantics.

public inline void ClearSecretKvs() ​

Clears the value of SecretKvs_Optional and sets SecretKvs_IsSet to false.

public inline bool IsSecretKvsSet() const ​

Checks whether SecretKvs_Optional has been set.

public inline FDateTime & GetKickBeforeHint() ​

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

public inline const FDateTime & GetKickBeforeHint() const ​

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

public inline const FDateTime & GetKickBeforeHint(const FDateTime & DefaultValue) const ​

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

public inline bool GetKickBeforeHint(FDateTime & OutValue) const ​

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

public inline FDateTime * GetKickBeforeHintOrNull() ​

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

public inline const FDateTime * GetKickBeforeHintOrNull() const ​

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

public inline void SetKickBeforeHint(const FDateTime & NewValue) ​

Sets the value of KickBeforeHint_Optional and also sets KickBeforeHint_IsSet to true.

public inline void SetKickBeforeHint(FDateTime && NewValue) ​

Sets the value of KickBeforeHint_Optional and also sets KickBeforeHint_IsSet to true using move semantics.

public inline void ClearKickBeforeHint() ​

Clears the value of KickBeforeHint_Optional and sets KickBeforeHint_IsSet to false.

public inline bool IsKickBeforeHintSet() const ​

Checks whether KickBeforeHint_Optional has been set.

public inline void SetKickBeforeHintToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsKickBeforeHintNull() const ​

Checks whether KickBeforeHint_Optional is set to null.