Class UpdateHealthCheckerDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • port

        public UpdateHealthCheckerDetails.Builder port​(Integer port)
        The backend server port against which to run the health check.

        Example: 8080

        Parameters:
        port - the value to set
        Returns:
        this builder
      • retries

        public UpdateHealthCheckerDetails.Builder retries​(Integer retries)
        The number of retries to attempt before a backend server is considered “unhealthy”.

        This number also applies when recovering a server to the “healthy” state.

        Example: 3

        Parameters:
        retries - the value to set
        Returns:
        this builder
      • timeoutInMillis

        public UpdateHealthCheckerDetails.Builder timeoutInMillis​(Integer timeoutInMillis)
        The maximum time, in milliseconds, to wait for a reply to a health check.

        A health check is successful only if a reply returns within this timeout period.

        Example: 3000

        Parameters:
        timeoutInMillis - the value to set
        Returns:
        this builder
      • intervalInMillis

        public UpdateHealthCheckerDetails.Builder intervalInMillis​(Integer intervalInMillis)
        The interval between health checks, in milliseconds.

        Example: 10000

        Parameters:
        intervalInMillis - the value to set
        Returns:
        this builder
      • urlPath

        public UpdateHealthCheckerDetails.Builder urlPath​(String urlPath)
        The path against which to run the health check.

        Example: /healthcheck

        Parameters:
        urlPath - the value to set
        Returns:
        this builder
      • responseBodyRegex

        public UpdateHealthCheckerDetails.Builder responseBodyRegex​(String responseBodyRegex)
        A regular expression for parsing the response body from the backend server.

        Example: ^((?!false).|\\s)*$

        Parameters:
        responseBodyRegex - the value to set
        Returns:
        this builder
      • returnCode

        public UpdateHealthCheckerDetails.Builder returnCode​(Integer returnCode)
        The status code a healthy backend server should return.

        If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as “200”.

        Example: 200

        Parameters:
        returnCode - the value to set
        Returns:
        this builder
      • requestData

        public UpdateHealthCheckerDetails.Builder requestData​(byte[] requestData)
        Base64 encoded pattern to be sent as UDP or TCP health check probe.
        Parameters:
        requestData - the value to set
        Returns:
        this builder
      • responseData

        public UpdateHealthCheckerDetails.Builder responseData​(byte[] responseData)
        Base64 encoded pattern to be validated as UDP or TCP health check probe response.
        Parameters:
        responseData - the value to set
        Returns:
        this builder