@Generated(value="software.amazon.awssdk:codegen") public final class VirtualGatewayHealthCheckPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VirtualGatewayHealthCheckPolicy.Builder,VirtualGatewayHealthCheckPolicy>
An object that represents the health check policy for a virtual gateway's listener.
Modifier and Type | Class and Description |
---|---|
static interface |
VirtualGatewayHealthCheckPolicy.Builder |
Modifier and Type | Method and Description |
---|---|
static VirtualGatewayHealthCheckPolicy.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
healthyThreshold()
The number of consecutive successful health checks that must occur before declaring the listener healthy.
|
Long |
intervalMillis()
The time period in milliseconds between each health check execution.
|
String |
path()
The destination path for the health check request.
|
Integer |
port()
The destination port for the health check request.
|
VirtualGatewayPortProtocol |
protocol()
The protocol for the health check request.
|
String |
protocolAsString()
The protocol for the health check request.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends VirtualGatewayHealthCheckPolicy.Builder> |
serializableBuilderClass() |
Long |
timeoutMillis()
The amount of time to wait when receiving a response from the health check, in milliseconds.
|
VirtualGatewayHealthCheckPolicy.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Integer |
unhealthyThreshold()
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
|
copy
public final Integer healthyThreshold()
The number of consecutive successful health checks that must occur before declaring the listener healthy.
public final Long intervalMillis()
The time period in milliseconds between each health check execution.
public final 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.
public final Integer port()
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
public final VirtualGatewayPortProtocol protocol()
The protocol for the health check request. If you specify grpc
, then your service must conform to
the GRPC Health Checking Protocol.
If the service returns an enum value that is not available in the current SDK version, protocol
will
return VirtualGatewayPortProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from protocolAsString()
.
grpc
, then your service must
conform to the GRPC Health
Checking Protocol.VirtualGatewayPortProtocol
public final String protocolAsString()
The protocol for the health check request. If you specify grpc
, then your service must conform to
the GRPC Health Checking Protocol.
If the service returns an enum value that is not available in the current SDK version, protocol
will
return VirtualGatewayPortProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from protocolAsString()
.
grpc
, then your service must
conform to the GRPC Health
Checking Protocol.VirtualGatewayPortProtocol
public final Long timeoutMillis()
The amount of time to wait when receiving a response from the health check, in milliseconds.
public final Integer unhealthyThreshold()
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
public VirtualGatewayHealthCheckPolicy.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<VirtualGatewayHealthCheckPolicy.Builder,VirtualGatewayHealthCheckPolicy>
public static VirtualGatewayHealthCheckPolicy.Builder builder()
public static Class<? extends VirtualGatewayHealthCheckPolicy.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()