software.amazon.awssdk.services.appmesh.model

Class HealthCheckPolicy

java.lang.Object

software.amazon.awssdk.services.appmesh.model.HealthCheckPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HealthCheckPolicy.Builder,HealthCheckPolicy>

@Generated(value="software.amazon.awssdk:codegen")
public final class HealthCheckPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HealthCheckPolicy.Builder,HealthCheckPolicy>

An object representing the health check policy for a virtual node's listener.

Listener health checks are not available during the App Mesh preview.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HealthCheckPolicy.Builder

Method Summary

Modifier and Type	Method and Description
static HealthCheckPolicy.Builder	builder()
boolean	equals(Object obj)
<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 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.
PortProtocol	protocol() The protocol for the health check request.
String	protocolAsString() The protocol for the health check request.
List<SdkField<?>>	sdkFields()
static Class<? extends HealthCheckPolicy.Builder>	serializableBuilderClass()
Long	timeoutMillis() The amount of time to wait when receiving a response from the health check, in milliseconds.
HealthCheckPolicy.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	unhealthyThreshold() The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

healthyThreshold

public Integer healthyThreshold()

The number of consecutive successful health checks that must occur before declaring listener healthy.

Returns:

The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis

public Long intervalMillis()

The time period in milliseconds between each health check execution.

Returns:

The time period in milliseconds between each health check execution.

path

public String path()

The destination path for the health check request.

Returns:

The destination path for the health check request.

port

public Integer port()

The destination port for the health check request.

Returns:

The destination port for the health check request.

protocol

public PortProtocol protocol()

The protocol for the health check request.

If the service returns an enum value that is not available in the current SDK version, protocol will return PortProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The protocol for the health check request.

See Also:

PortProtocol

protocolAsString

public String protocolAsString()

The protocol for the health check request.

If the service returns an enum value that is not available in the current SDK version, protocol will return PortProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The protocol for the health check request.

See Also:

PortProtocol

timeoutMillis

public Long 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

public Integer unhealthyThreshold()

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

Returns:

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

toBuilder

public HealthCheckPolicy.Builder 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 interface ToCopyableBuilder<HealthCheckPolicy.Builder,HealthCheckPolicy>

Returns:

a builder for type T

builder

public static HealthCheckPolicy.Builder builder()

serializableBuilderClass

public static Class<? extends HealthCheckPolicy.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.