Interface HealthCheckPolicy.Builder

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

  • Method Details

    • healthyThreshold

      HealthCheckPolicy.Builder healthyThreshold(Integer healthyThreshold)

      The number of consecutive successful health checks that must occur before declaring listener healthy.

      Parameters:
      healthyThreshold - The number of consecutive successful health checks that must occur before declaring listener healthy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intervalMillis

      HealthCheckPolicy.Builder intervalMillis(Long intervalMillis)

      The time period in milliseconds between each health check execution.

      Parameters:
      intervalMillis - The time period in milliseconds between each health check execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      HealthCheckPolicy.Builder path(String path)

      The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

      Parameters:
      path - The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • port

      HealthCheckPolicy.Builder port(Integer port)

      The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

      Parameters:
      port - The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      HealthCheckPolicy.Builder protocol(String protocol)

      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

      Parameters:
      protocol - The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      HealthCheckPolicy.Builder protocol(PortProtocol protocol)

      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

      Parameters:
      protocol - The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeoutMillis

      HealthCheckPolicy.Builder timeoutMillis(Long timeoutMillis)

      The amount of time to wait when receiving a response from the health check, in milliseconds.

      Parameters:
      timeoutMillis - The amount of time to wait when receiving a response from the health check, in milliseconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unhealthyThreshold

      HealthCheckPolicy.Builder unhealthyThreshold(Integer unhealthyThreshold)

      The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

      Parameters:
      unhealthyThreshold - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.