Interface GatewayConnectorHealthCheck.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GatewayConnectorHealthCheck.Builder,GatewayConnectorHealthCheck>, SdkBuilder<GatewayConnectorHealthCheck.Builder,GatewayConnectorHealthCheck>, SdkPojo
Enclosing class:
GatewayConnectorHealthCheck
@Mutable @NotThreadSafe public static interface GatewayConnectorHealthCheck.Builder extends SdkPojo, CopyableBuilder<GatewayConnectorHealthCheck.Builder,GatewayConnectorHealthCheck>

  • Method Details

    • healthCheckProtocol

      GatewayConnectorHealthCheck.Builder healthCheckProtocol(String healthCheckProtocol)

      The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

      Parameters:
      healthCheckProtocol - The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthCheckProtocol

      GatewayConnectorHealthCheck.Builder healthCheckProtocol(GatewayConnectorHealthCheckProtocol healthCheckProtocol)

      The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

      Parameters:
      healthCheckProtocol - The protocol that the gateway uses to perform health checks.

      Valid values:

      • HTTP - Health checks are performed over HTTP.

      • HTTPS - Health checks are performed over HTTPS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthCheckPort

      GatewayConnectorHealthCheck.Builder healthCheckPort(Integer healthCheckPort)

      The port that the gateway uses to perform health checks on the targets.

      Parameters:
      healthCheckPort - The port that the gateway uses to perform health checks on the targets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckPath

      GatewayConnectorHealthCheck.Builder healthCheckPath(String healthCheckPath)

      The destination path for health check requests.

      Parameters:
      healthCheckPath - The destination path for health check requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckTimeoutSeconds

      GatewayConnectorHealthCheck.Builder healthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)

      The amount of time, in seconds, during which no response from a target means a failed health check.

      Parameters:
      healthCheckTimeoutSeconds - The amount of time, in seconds, during which no response from a target means a failed health check.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckIntervalSeconds

      GatewayConnectorHealthCheck.Builder healthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)

      The approximate amount of time, in seconds, between health checks of an individual target.

      Parameters:
      healthCheckIntervalSeconds - The approximate amount of time, in seconds, between health checks of an individual target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthyThresholdCount

      GatewayConnectorHealthCheck.Builder healthyThresholdCount(Integer healthyThresholdCount)

      The number of consecutive successful health checks that a target must pass before the gateway considers it healthy.

      Parameters:
      healthyThresholdCount - The number of consecutive successful health checks that a target must pass before the gateway considers it healthy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unhealthyThresholdCount

      GatewayConnectorHealthCheck.Builder unhealthyThresholdCount(Integer unhealthyThresholdCount)

      The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy.

      Parameters:
      unhealthyThresholdCount - The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matcher

      GatewayConnectorHealthCheck.Builder matcher(GatewayConnectorHealthCheckMatcher matcher)

      The HTTP or gRPC codes that indicate a successful health check response from a target.

      Parameters:
      matcher - The HTTP or gRPC codes that indicate a successful health check response from a target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matcher

      default GatewayConnectorHealthCheck.Builder matcher(Consumer<GatewayConnectorHealthCheckMatcher.Builder> matcher)

      The HTTP or gRPC codes that indicate a successful health check response from a target.

      This is a convenience method that creates an instance of the GatewayConnectorHealthCheckMatcher.Builder avoiding the need to create one manually via GatewayConnectorHealthCheckMatcher.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matcher(GatewayConnectorHealthCheckMatcher).

      Parameters:
      matcher - a consumer that will call methods on GatewayConnectorHealthCheckMatcher.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: