Class VirtualGatewayHealthCheckPolicy
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VirtualGatewayHealthCheckPolicy.Builder,
VirtualGatewayHealthCheckPolicy>
An object that represents the health check policy for a virtual gateway's listener.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The number of consecutive successful health checks that must occur before declaring the listener healthy.final Long
The time period in milliseconds between each health check execution.final String
path()
The destination path for the health check request.final Integer
port()
The destination port for the health check request.protocol()
The protocol for the health check request.final String
The protocol for the health check request.static Class
<? extends VirtualGatewayHealthCheckPolicy.Builder> final Long
The amount of time to wait when receiving a response from the health check, in milliseconds.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
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.ToCopyableBuilder
copy
-
Method Details
-
healthyThreshold
The number of consecutive successful health checks that must occur before declaring the listener healthy.
- Returns:
- The number of consecutive successful health checks that must occur before declaring the listener healthy.
-
intervalMillis
The time period in milliseconds between each health check execution.
- Returns:
- The time period in milliseconds between each health check execution.
-
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:
- 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.
-
port
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
- Returns:
- The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
-
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 returnVirtualGatewayPortProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The protocol for the health check request. If you specify
grpc
, then your service must conform to the GRPC Health Checking Protocol. - See Also:
-
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 returnVirtualGatewayPortProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The protocol for the health check request. If you specify
grpc
, then your service must conform to the GRPC Health Checking Protocol. - See Also:
-
timeoutMillis
The amount of time to wait when receiving a response from the health check, in milliseconds.
- Returns:
- The amount of time to wait when receiving a response from the health check, in milliseconds.
-
unhealthyThreshold
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
- Returns:
- The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VirtualGatewayHealthCheckPolicy.Builder,
VirtualGatewayHealthCheckPolicy> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-