@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class VirtualGatewayHealthCheckPolicy extends Object implements Serializable, Cloneable, StructuredPojo
An object that represents the health check policy for a virtual gateway's listener.
Constructor and Description |
---|
VirtualGatewayHealthCheckPolicy() |
Modifier and Type | Method and Description |
---|---|
VirtualGatewayHealthCheckPolicy |
clone() |
boolean |
equals(Object obj) |
Integer |
getHealthyThreshold()
The number of consecutive successful health checks that must occur before declaring the listener healthy.
|
Long |
getIntervalMillis()
The time period in milliseconds between each health check execution.
|
String |
getPath()
The destination path for the health check request.
|
Integer |
getPort()
The destination port for the health check request.
|
String |
getProtocol()
The protocol for the health check request.
|
Long |
getTimeoutMillis()
The amount of time to wait when receiving a response from the health check, in milliseconds.
|
Integer |
getUnhealthyThreshold()
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setHealthyThreshold(Integer healthyThreshold)
The number of consecutive successful health checks that must occur before declaring the listener healthy.
|
void |
setIntervalMillis(Long intervalMillis)
The time period in milliseconds between each health check execution.
|
void |
setPath(String path)
The destination path for the health check request.
|
void |
setPort(Integer port)
The destination port for the health check request.
|
void |
setProtocol(String protocol)
The protocol for the health check request.
|
void |
setTimeoutMillis(Long timeoutMillis)
The amount of time to wait when receiving a response from the health check, in milliseconds.
|
void |
setUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
|
String |
toString()
Returns a string representation of this object.
|
VirtualGatewayHealthCheckPolicy |
withHealthyThreshold(Integer healthyThreshold)
The number of consecutive successful health checks that must occur before declaring the listener healthy.
|
VirtualGatewayHealthCheckPolicy |
withIntervalMillis(Long intervalMillis)
The time period in milliseconds between each health check execution.
|
VirtualGatewayHealthCheckPolicy |
withPath(String path)
The destination path for the health check request.
|
VirtualGatewayHealthCheckPolicy |
withPort(Integer port)
The destination port for the health check request.
|
VirtualGatewayHealthCheckPolicy |
withProtocol(String protocol)
The protocol for the health check request.
|
VirtualGatewayHealthCheckPolicy |
withProtocol(VirtualGatewayPortProtocol protocol)
The protocol for the health check request.
|
VirtualGatewayHealthCheckPolicy |
withTimeoutMillis(Long timeoutMillis)
The amount of time to wait when receiving a response from the health check, in milliseconds.
|
VirtualGatewayHealthCheckPolicy |
withUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
|
public void setHealthyThreshold(Integer healthyThreshold)
The number of consecutive successful health checks that must occur before declaring the listener healthy.
healthyThreshold
- The number of consecutive successful health checks that must occur before declaring the listener healthy.public Integer getHealthyThreshold()
The number of consecutive successful health checks that must occur before declaring the listener healthy.
public VirtualGatewayHealthCheckPolicy withHealthyThreshold(Integer healthyThreshold)
The number of consecutive successful health checks that must occur before declaring the listener healthy.
healthyThreshold
- The number of consecutive successful health checks that must occur before declaring the listener healthy.public void setIntervalMillis(Long intervalMillis)
The time period in milliseconds between each health check execution.
intervalMillis
- The time period in milliseconds between each health check execution.public Long getIntervalMillis()
The time period in milliseconds between each health check execution.
public VirtualGatewayHealthCheckPolicy withIntervalMillis(Long intervalMillis)
The time period in milliseconds between each health check execution.
intervalMillis
- The time period in milliseconds between each health check execution.public void setPath(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.
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.public String getPath()
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.
public VirtualGatewayHealthCheckPolicy withPath(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.
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.public void setPort(Integer port)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
port
- The destination port for the health check request. This port must match the port defined in the
PortMapping for the listener.public Integer getPort()
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
public VirtualGatewayHealthCheckPolicy withPort(Integer port)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
port
- The destination port for the health check request. This port must match the port defined in the
PortMapping for the listener.public void setProtocol(String protocol)
The protocol for the health check request. If you specify grpc
, then your service must conform to
the GRPC Health Checking Protocol.
protocol
- The protocol for the health check request. If you specify grpc
, then your service must
conform to the GRPC Health
Checking Protocol.VirtualGatewayPortProtocol
public String getProtocol()
The protocol for the health check request. If you specify grpc
, then your service must conform to
the GRPC Health Checking Protocol.
grpc
, then your service must
conform to the GRPC Health
Checking Protocol.VirtualGatewayPortProtocol
public VirtualGatewayHealthCheckPolicy withProtocol(String protocol)
The protocol for the health check request. If you specify grpc
, then your service must conform to
the GRPC Health Checking Protocol.
protocol
- The protocol for the health check request. If you specify grpc
, then your service must
conform to the GRPC Health
Checking Protocol.VirtualGatewayPortProtocol
public VirtualGatewayHealthCheckPolicy withProtocol(VirtualGatewayPortProtocol protocol)
The protocol for the health check request. If you specify grpc
, then your service must conform to
the GRPC Health Checking Protocol.
protocol
- The protocol for the health check request. If you specify grpc
, then your service must
conform to the GRPC Health
Checking Protocol.VirtualGatewayPortProtocol
public void setTimeoutMillis(Long timeoutMillis)
The amount of time to wait when receiving a response from the health check, in milliseconds.
timeoutMillis
- The amount of time to wait when receiving a response from the health check, in milliseconds.public Long getTimeoutMillis()
The amount of time to wait when receiving a response from the health check, in milliseconds.
public VirtualGatewayHealthCheckPolicy withTimeoutMillis(Long timeoutMillis)
The amount of time to wait when receiving a response from the health check, in milliseconds.
timeoutMillis
- The amount of time to wait when receiving a response from the health check, in milliseconds.public void setUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
unhealthyThreshold
- The number of consecutive failed health checks that must occur before declaring a virtual gateway
unhealthy.public Integer getUnhealthyThreshold()
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
public VirtualGatewayHealthCheckPolicy withUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
unhealthyThreshold
- The number of consecutive failed health checks that must occur before declaring a virtual gateway
unhealthy.public String toString()
toString
in class Object
Object.toString()
public VirtualGatewayHealthCheckPolicy clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.