HealthCheckConfig (AWS Java SDK :: Services :: VPC Lattice 2.20.125 API)

java.lang.Object
- software.amazon.awssdk.services.vpclattice.model.HealthCheckConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class HealthCheckConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
```
The health check configuration of a target group. Health check configurations aren't used for LAMBDA and ALB target groups.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HealthCheckConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HealthCheckConfig.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HealthCheckConfig.Builder`	`builder()`
`Boolean`	`enabled()` Indicates whether health checking is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`healthCheckIntervalSeconds()` The approximate amount of time, in seconds, between health checks of an individual target.
`Integer`	`healthCheckTimeoutSeconds()` The amount of time, in seconds, to wait before reporting a target as unhealthy.
`Integer`	`healthyThresholdCount()` The number of consecutive successful health checks required before considering an unhealthy target healthy.
`Matcher`	`matcher()` The codes to use when checking for a successful response from a target.
`String`	`path()` The destination for health checks on the targets.
`Integer`	`port()` The port used when performing health checks on targets.
`TargetGroupProtocol`	`protocol()` The protocol used when performing health checks on targets.
`String`	`protocolAsString()` The protocol used when performing health checks on targets.
`HealthCheckProtocolVersion`	`protocolVersion()` The protocol version used when performing health checks on targets.
`String`	`protocolVersionAsString()` The protocol version used when performing health checks on targets.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HealthCheckConfig.Builder>`	`serializableBuilderClass()`
`HealthCheckConfig.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`unhealthyThresholdCount()` The number of consecutive failed health checks required before considering a target unhealthy.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - enabled
```
public final Boolean enabled()
```
    Indicates whether health checking is enabled.
    
    Returns:
    
    Indicates whether health checking is enabled.
  - healthCheckIntervalSeconds
```
public final Integer healthCheckIntervalSeconds()
```
    The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
    
    Returns:
    
    The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
  - healthCheckTimeoutSeconds
```
public final Integer healthCheckTimeoutSeconds()
```
    The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
    
    Returns:
    
    The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
  - healthyThresholdCount
```
public final Integer healthyThresholdCount()
```
    The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
    
    Returns:
    
    The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
  - matcher
```
public final Matcher matcher()
```
    The codes to use when checking for a successful response from a target. These are called Success codes in the console.
    
    Returns:
    
    The codes to use when checking for a successful response from a target. These are called Success codes in the console.
  - path
```
public final String path()
```
    The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.
    
    Returns:
    
    The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.
  - port
```
public final Integer port()
```
    The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
    
    Returns:
    
    The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
  - protocol
```
public final TargetGroupProtocol protocol()
```
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return TargetGroupProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    
    See Also:
    
    TargetGroupProtocol
  - protocolAsString
```
public final String protocolAsString()
```
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return TargetGroupProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    
    See Also:
    
    TargetGroupProtocol
  - protocolVersion
```
public final HealthCheckProtocolVersion protocolVersion()
```
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    
    If the service returns an enum value that is not available in the current SDK version, protocolVersion will return HealthCheckProtocolVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolVersionAsString().
    
    Returns:
    
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    
    See Also:
    
    HealthCheckProtocolVersion
  - protocolVersionAsString
```
public final String protocolVersionAsString()
```
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    
    If the service returns an enum value that is not available in the current SDK version, protocolVersion will return HealthCheckProtocolVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolVersionAsString().
    
    Returns:
    
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    
    See Also:
    
    HealthCheckProtocolVersion
  - unhealthyThresholdCount
```
public final Integer unhealthyThresholdCount()
```
    The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
    
    Returns:
    
    The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
  - toBuilder
```
public HealthCheckConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
  - builder
```
public static HealthCheckConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HealthCheckConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class HealthCheckConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

enabled

healthCheckIntervalSeconds

healthCheckTimeoutSeconds

healthyThresholdCount

matcher

path

port

protocol

protocolAsString

protocolVersion

protocolVersionAsString

unhealthyThresholdCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields