Class UpdateHealthCheckerDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20170115")
    public final class UpdateHealthCheckerDetails
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The health checker’s configuration details.
    Note: Objects should always be created or deserialized using the UpdateHealthCheckerDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the UpdateHealthCheckerDetails.Builder, which maintain a set of all explicitly set fields called UpdateHealthCheckerDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
    • Constructor Detail

      • UpdateHealthCheckerDetails

        @Deprecated
        @ConstructorProperties({"protocol","urlPath","port","returnCode","retries","timeoutInMillis","intervalInMillis","responseBodyRegex","isDynamicBackendWeightEnabled","defaultWeight","isForcePlainText"})
        public UpdateHealthCheckerDetails​(String protocol,
                                          String urlPath,
                                          Integer port,
                                          Integer returnCode,
                                          Integer retries,
                                          Integer timeoutInMillis,
                                          Integer intervalInMillis,
                                          String responseBodyRegex,
                                          Boolean isDynamicBackendWeightEnabled,
                                          Integer defaultWeight,
                                          Boolean isForcePlainText)
        Deprecated.
    • Method Detail

      • getProtocol

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

        Example: HTTP

        Returns:
        the value
      • getUrlPath

        public String getUrlPath()
        The path against which to run the health check.

        Example: /healthcheck

        Returns:
        the value
      • getPort

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

        Example: 8080

        Returns:
        the value
      • getReturnCode

        public Integer getReturnCode()
        The status code a healthy backend server should return.

        Example: 200

        Returns:
        the value
      • getRetries

        public Integer getRetries()
        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

        Returns:
        the value
      • getTimeoutInMillis

        public Integer getTimeoutInMillis()
        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

        Returns:
        the value
      • getIntervalInMillis

        public Integer getIntervalInMillis()
        The interval between health checks, in milliseconds.

        Example: 10000

        Returns:
        the value
      • getResponseBodyRegex

        public String getResponseBodyRegex()
        A regular expression for parsing the response body from the backend server.

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

        Returns:
        the value
      • getIsDynamicBackendWeightEnabled

        public Boolean getIsDynamicBackendWeightEnabled()
        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.

        Update semantics: * omitted: preserve existing value. * false: disable dynamic backend weight. * true: enable dynamic backend weight.

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

        Returns:
        the value
      • getDefaultWeight

        public Integer getDefaultWeight()
        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.

        Update semantics: * provided: replace the existing value. * omitted or null: preserve the existing configured value.

        If dynamic backend weights are enabled and no existing defaultWeight is present, the service uses 1.

        Setting or updating 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.

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

        Example: 1

        Returns:
        the value
      • getIsForcePlainText

        public Boolean getIsForcePlainText()
        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: true

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel