Class HealthCheckMetaData

java.lang.Object
com.kingsrook.qqq.middleware.health.model.metadata.HealthCheckMetaData
All Implemented Interfaces:
MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable
public class HealthCheckMetaData extends Object implements QSupplementalInstanceMetaData
MetaData for health check configuration. This class implements QSupplementalInstanceMetaData to integrate with QInstance without requiring changes to the core QInstance class.
See Also:

  • Field Details

  • Constructor Details

    • HealthCheckMetaData

      public HealthCheckMetaData()

  • Method Details

    • getName

      public String getName()
      Get the unique key for this supplemental metadata. Required by QSupplementalInstanceMetaData interface.
      Specified by:
      getName in interface TopLevelMetaDataInterface

    • addSelfToInstance

      public void addSelfToInstance(QInstance qInstance)
      Add this metadata to the QInstance. Required by QSupplementalInstanceMetaData interface.
      Specified by:
      addSelfToInstance in interface MetaDataProducerOutput
      Specified by:
      addSelfToInstance in interface QSupplementalInstanceMetaData
      Specified by:
      addSelfToInstance in interface TopLevelMetaDataInterface

    • withEnabled

      public HealthCheckMetaData withEnabled(Boolean enabled)
      Fluent setter for enabled

    • withEndpointPath

      public HealthCheckMetaData withEndpointPath(String endpointPath)
      Fluent setter for endpointPath

    • withIndicators

      public HealthCheckMetaData withIndicators(List<HealthIndicator> indicators)
      Fluent setter for indicators

    • withAuthenticator

      public HealthCheckMetaData withAuthenticator(QCodeReference authenticator)
      Fluent setter for authenticator

    • withRequiredSecurityKeyType

      public HealthCheckMetaData withRequiredSecurityKeyType(String requiredSecurityKeyType)
      Fluent setter for requiredSecurityKeyType

    • withTimeoutMs

      public HealthCheckMetaData withTimeoutMs(Integer timeoutMs)
      Fluent setter for timeoutMs

    • getEnabled

      public Boolean getEnabled()
      Getter for enabled

    • setEnabled

      public void setEnabled(Boolean enabled)
      Setter for enabled

    • getEndpointPath

      public String getEndpointPath()
      Getter for endpointPath

    • setEndpointPath

      public void setEndpointPath(String endpointPath)
      Setter for endpointPath

    • getIndicators

      public List<HealthIndicator> getIndicators()
      Getter for indicators

    • setIndicators

      public void setIndicators(List<HealthIndicator> indicators)
      Setter for indicators

    • getAuthenticator

      public QCodeReference getAuthenticator()
      Getter for authenticator

    • setAuthenticator

      public void setAuthenticator(QCodeReference authenticator)
      Setter for authenticator

    • getRequiredSecurityKeyType

      public String getRequiredSecurityKeyType()
      Getter for requiredSecurityKeyType

    • setRequiredSecurityKeyType

      public void setRequiredSecurityKeyType(String requiredSecurityKeyType)
      Setter for requiredSecurityKeyType

    • getTimeoutMs

      public Integer getTimeoutMs()
      Getter for timeoutMs

    • setTimeoutMs

      public void setTimeoutMs(Integer timeoutMs)
      Setter for timeoutMs