Skip to main content

RHAPI_InstanceHealthSettingsResponse

Summary​

MembersDescriptions
struct FRHAPI_InstanceHealthSettingsResponse

struct FRHAPI_InstanceHealthSettingsResponse ​

struct FRHAPI_InstanceHealthSettingsResponse
  : public FRHAPI_Model

Summary​

MembersDescriptions
public int32 CadenceSecondsHow often we expect instance health checks to occur.
public float UnhealthyHealthCheckPercentageWhat percentage of health checks must be missing before an instance's status becomes unhealthy.
public int32 MissedChecksBeforeUnknownHow many health checks we must miss in a row before an instance's status becomes unknown.
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 int32 & GetCadenceSeconds()Gets the value of CadenceSeconds.
public inline const int32 & GetCadenceSeconds() constGets the value of CadenceSeconds.
public inline void SetCadenceSeconds(const int32 & NewValue)Sets the value of CadenceSeconds.
public inline void SetCadenceSeconds(int32 && NewValue)Sets the value of CadenceSeconds using move semantics.
public inline bool IsCadenceSecondsDefaultValue() constReturns true if CadenceSeconds matches the default value.
public inline void SetCadenceSecondsToDefault()Sets the value of CadenceSeconds to its default
public inline float & GetUnhealthyHealthCheckPercentage()Gets the value of UnhealthyHealthCheckPercentage.
public inline const float & GetUnhealthyHealthCheckPercentage() constGets the value of UnhealthyHealthCheckPercentage.
public inline void SetUnhealthyHealthCheckPercentage(const float & NewValue)Sets the value of UnhealthyHealthCheckPercentage.
public inline void SetUnhealthyHealthCheckPercentage(float && NewValue)Sets the value of UnhealthyHealthCheckPercentage using move semantics.
public inline int32 & GetMissedChecksBeforeUnknown()Gets the value of MissedChecksBeforeUnknown.
public inline const int32 & GetMissedChecksBeforeUnknown() constGets the value of MissedChecksBeforeUnknown.
public inline void SetMissedChecksBeforeUnknown(const int32 & NewValue)Sets the value of MissedChecksBeforeUnknown.
public inline void SetMissedChecksBeforeUnknown(int32 && NewValue)Sets the value of MissedChecksBeforeUnknown using move semantics.
public inline bool IsMissedChecksBeforeUnknownDefaultValue() constReturns true if MissedChecksBeforeUnknown matches the default value.
public inline void SetMissedChecksBeforeUnknownToDefault()Sets the value of MissedChecksBeforeUnknown to its default

Members​

public int32 CadenceSeconds ​

How often we expect instance health checks to occur.

public float UnhealthyHealthCheckPercentage ​

What percentage of health checks must be missing before an instance's status becomes unhealthy.

public int32 MissedChecksBeforeUnknown ​

How many health checks we must miss in a row before an instance's status becomes unknown.

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

Gets the value of CadenceSeconds.

public inline const int32 & GetCadenceSeconds() const ​

Gets the value of CadenceSeconds.

public inline void SetCadenceSeconds(const int32 & NewValue) ​

Sets the value of CadenceSeconds.

public inline void SetCadenceSeconds(int32 && NewValue) ​

Sets the value of CadenceSeconds using move semantics.

public inline bool IsCadenceSecondsDefaultValue() const ​

Returns true if CadenceSeconds matches the default value.

public inline void SetCadenceSecondsToDefault() ​

Sets the value of CadenceSeconds to its default

public inline float & GetUnhealthyHealthCheckPercentage() ​

Gets the value of UnhealthyHealthCheckPercentage.

public inline const float & GetUnhealthyHealthCheckPercentage() const ​

Gets the value of UnhealthyHealthCheckPercentage.

public inline void SetUnhealthyHealthCheckPercentage(const float & NewValue) ​

Sets the value of UnhealthyHealthCheckPercentage.

public inline void SetUnhealthyHealthCheckPercentage(float && NewValue) ​

Sets the value of UnhealthyHealthCheckPercentage using move semantics.

public inline int32 & GetMissedChecksBeforeUnknown() ​

Gets the value of MissedChecksBeforeUnknown.

public inline const int32 & GetMissedChecksBeforeUnknown() const ​

Gets the value of MissedChecksBeforeUnknown.

public inline void SetMissedChecksBeforeUnknown(const int32 & NewValue) ​

Sets the value of MissedChecksBeforeUnknown.

public inline void SetMissedChecksBeforeUnknown(int32 && NewValue) ​

Sets the value of MissedChecksBeforeUnknown using move semantics.

public inline bool IsMissedChecksBeforeUnknownDefaultValue() const ​

Returns true if MissedChecksBeforeUnknown matches the default value.

public inline void SetMissedChecksBeforeUnknownToDefault() ​

Sets the value of MissedChecksBeforeUnknown to its default