Interface VirtualGatewayHealthCheckPolicy.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<VirtualGatewayHealthCheckPolicy.Builder,VirtualGatewayHealthCheckPolicy>,SdkBuilder<VirtualGatewayHealthCheckPolicy.Builder,VirtualGatewayHealthCheckPolicy>,SdkPojo
- Enclosing class:
- VirtualGatewayHealthCheckPolicy
public static interface VirtualGatewayHealthCheckPolicy.Builder extends SdkPojo, CopyableBuilder<VirtualGatewayHealthCheckPolicy.Builder,VirtualGatewayHealthCheckPolicy>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VirtualGatewayHealthCheckPolicy.BuilderhealthyThreshold(Integer healthyThreshold)The number of consecutive successful health checks that must occur before declaring the listener healthy.VirtualGatewayHealthCheckPolicy.BuilderintervalMillis(Long intervalMillis)The time period in milliseconds between each health check execution.VirtualGatewayHealthCheckPolicy.Builderpath(String path)The destination path for the health check request.VirtualGatewayHealthCheckPolicy.Builderport(Integer port)The destination port for the health check request.VirtualGatewayHealthCheckPolicy.Builderprotocol(String protocol)The protocol for the health check request.VirtualGatewayHealthCheckPolicy.Builderprotocol(VirtualGatewayPortProtocol protocol)The protocol for the health check request.VirtualGatewayHealthCheckPolicy.BuildertimeoutMillis(Long timeoutMillis)The amount of time to wait when receiving a response from the health check, in milliseconds.VirtualGatewayHealthCheckPolicy.BuilderunhealthyThreshold(Integer unhealthyThreshold)The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
healthyThreshold
VirtualGatewayHealthCheckPolicy.Builder healthyThreshold(Integer healthyThreshold)
The number of consecutive successful health checks that must occur before declaring the listener healthy.
- Parameters:
healthyThreshold- The number of consecutive successful health checks that must occur before declaring the listener healthy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
intervalMillis
VirtualGatewayHealthCheckPolicy.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
VirtualGatewayHealthCheckPolicy.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
VirtualGatewayHealthCheckPolicy.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
VirtualGatewayHealthCheckPolicy.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 specifygrpc, 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:
VirtualGatewayPortProtocol,VirtualGatewayPortProtocol
-
protocol
VirtualGatewayHealthCheckPolicy.Builder protocol(VirtualGatewayPortProtocol 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 specifygrpc, 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:
VirtualGatewayPortProtocol,VirtualGatewayPortProtocol
-
timeoutMillis
VirtualGatewayHealthCheckPolicy.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
VirtualGatewayHealthCheckPolicy.Builder unhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
- Parameters:
unhealthyThreshold- The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-