Class HealthCheckerDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • protocol

        public HealthCheckerDetails.Builder protocol​(String protocol)
        The protocol the health check must use; either HTTP or TCP.

        Example: HTTP

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

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

        Example: /healthcheck

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

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

        If the port is not specified, the load balancer uses the port information from the Backend object.

        Example: 8080

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

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

        Example: 200

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

        public HealthCheckerDetails.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 HealthCheckerDetails.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 HealthCheckerDetails.Builder intervalInMillis​(Integer intervalInMillis)
        The interval between health checks, in milliseconds.

        Example: 10000

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

        public HealthCheckerDetails.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
      • isDynamicBackendWeightEnabled

        public HealthCheckerDetails.Builder isDynamicBackendWeightEnabled​(Boolean isDynamicBackendWeightEnabled)
        You can enable dynamic backend weights for HTTP health checks.

        When enabled, the load balancer reads the X-Dynamic-Backend-Weight header from each backend's HTTP health check response. The load balancer uses that value as the backend's effective weight when distributing traffic.

        A valid header value is an integer from 0 through 100.

        If the backend response does not include this header, or includes an invalid value, the load balancer uses defaultWeight.

        If omitted during create, the default is false.

        For TCP health checks, this field is accepted and stored, but it has no runtime effect.

        Parameters:
        isDynamicBackendWeightEnabled - the value to set
        Returns:
        this builder
      • defaultWeight

        public HealthCheckerDetails.Builder defaultWeight​(Integer defaultWeight)
        You can configure this fallback backend weight when dynamic backend weights are enabled and the backend’s HTTP health check response does not include a valid X-Dynamic-Backend-Weight header value.

        This value must be an integer from 1 through 100.

        Setting defaultWeight does not enable dynamic backend weights. To enable dynamic backend weights, set isDynamicBackendWeightEnabled to true. If your request includes defaultWeight, you must also set isDynamicBackendWeightEnabled to true; otherwise, the request is rejected.

        On create, if dynamic backend weights are enabled and this field is omitted or null, the service uses 1.

        For TCP health checks, this field is accepted and stored, but it has no runtime effect.

        Example: 1

        Parameters:
        defaultWeight - the value to set
        Returns:
        this builder
      • isForcePlainText

        public HealthCheckerDetails.Builder isForcePlainText​(Boolean isForcePlainText)
        Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.

        If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL.

        If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text.

        Example: false

        Parameters:
        isForcePlainText - the value to set
        Returns:
        this builder