HealthCheckPolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appmesh.model.HealthCheckPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HealthCheckPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that represents the health check policy for a virtual node's listener.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HealthCheckPolicy()

Constructors
Constructor and Description
`HealthCheckPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HealthCheckPolicy`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getHealthyThreshold()` The number of consecutive successful health checks that must occur before declaring 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 node 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 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 node unhealthy.
`String`	`toString()` Returns a string representation of this object.
`HealthCheckPolicy`	`withHealthyThreshold(Integer healthyThreshold)` The number of consecutive successful health checks that must occur before declaring listener healthy.
`HealthCheckPolicy`	`withIntervalMillis(Long intervalMillis)` The time period in milliseconds between each health check execution.
`HealthCheckPolicy`	`withPath(String path)` The destination path for the health check request.
`HealthCheckPolicy`	`withPort(Integer port)` The destination port for the health check request.
`HealthCheckPolicy`	`withProtocol(PortProtocol protocol)` The protocol for the health check request.
`HealthCheckPolicy`	`withProtocol(String protocol)` The protocol for the health check request.
`HealthCheckPolicy`	`withTimeoutMillis(Long timeoutMillis)` The amount of time to wait when receiving a response from the health check, in milliseconds.
`HealthCheckPolicy`	`withUnhealthyThreshold(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

- Constructor Detail
  - HealthCheckPolicy
```
public HealthCheckPolicy()
```
- Method Detail
  - setHealthyThreshold
```
public void setHealthyThreshold(Integer healthyThreshold)
```
    The number of consecutive successful health checks that must occur before declaring listener healthy.
    
    Parameters:
    
    healthyThreshold - The number of consecutive successful health checks that must occur before declaring listener healthy.
  - getHealthyThreshold
```
public Integer getHealthyThreshold()
```
    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.
  - withHealthyThreshold
```
public HealthCheckPolicy withHealthyThreshold(Integer healthyThreshold)
```
    The number of consecutive successful health checks that must occur before declaring listener healthy.
    
    Parameters:
    
    healthyThreshold - The number of consecutive successful health checks that must occur before declaring listener healthy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIntervalMillis
```
public void setIntervalMillis(Long intervalMillis)
```
    The time period in milliseconds between each health check execution.
    
    Parameters:
    
    intervalMillis - The time period in milliseconds between each health check execution.
  - getIntervalMillis
```
public Long getIntervalMillis()
```
    The time period in milliseconds between each health check execution.
    
    Returns:
    
    The time period in milliseconds between each health check execution.
  - withIntervalMillis
```
public HealthCheckPolicy withIntervalMillis(Long intervalMillis)
```
    The time period in milliseconds between each health check execution.
    
    Parameters:
    
    intervalMillis - The time period in milliseconds between each health check execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(String path)
```
    The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
    
    Parameters:
    
    path - The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
  - getPath
```
public String getPath()
```
    The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
    
    Returns:
    
    The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
  - withPath
```
public HealthCheckPolicy withPath(String path)
```
    The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
    
    Parameters:
    
    path - The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
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.
    
    Parameters:
    
    port - The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
  - getPort
```
public Integer getPort()
```
    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.
  - withPort
```
public HealthCheckPolicy withPort(Integer port)
```
    The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
    
    Parameters:
    
    port - The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol for the health check request.
    
    Parameters:
    
    protocol - The protocol for the health check request.
    
    See Also:
    
    PortProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol for the health check request.
    
    Returns:
    
    The protocol for the health check request.
    
    See Also:
    
    PortProtocol
  - withProtocol
```
public HealthCheckPolicy withProtocol(String protocol)
```
    The protocol for the health check request.
    
    Parameters:
    
    protocol - The protocol for the health check request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortProtocol
  - withProtocol
```
public HealthCheckPolicy withProtocol(PortProtocol protocol)
```
    The protocol for the health check request.
    
    Parameters:
    
    protocol - The protocol for the health check request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortProtocol
  - setTimeoutMillis
```
public void setTimeoutMillis(Long timeoutMillis)
```
    The amount of time to wait when receiving a response from the health check, in milliseconds.
    
    Parameters:
    
    timeoutMillis - The amount of time to wait when receiving a response from the health check, in milliseconds.
  - getTimeoutMillis
```
public Long getTimeoutMillis()
```
    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.
  - withTimeoutMillis
```
public HealthCheckPolicy withTimeoutMillis(Long timeoutMillis)
```
    The amount of time to wait when receiving a response from the health check, in milliseconds.
    
    Parameters:
    
    timeoutMillis - The amount of time to wait when receiving a response from the health check, in milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnhealthyThreshold
```
public void setUnhealthyThreshold(Integer unhealthyThreshold)
```
    The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
    
    Parameters:
    
    unhealthyThreshold - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
  - getUnhealthyThreshold
```
public Integer getUnhealthyThreshold()
```
    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.
  - withUnhealthyThreshold
```
public HealthCheckPolicy withUnhealthyThreshold(Integer unhealthyThreshold)
```
    The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
    
    Parameters:
    
    unhealthyThreshold - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HealthCheckPolicy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class HealthCheckPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthCheckPolicy

Method Detail

setHealthyThreshold

getHealthyThreshold

withHealthyThreshold

setIntervalMillis

getIntervalMillis

withIntervalMillis

setPath

getPath

withPath

setPort

getPort

withPort

setProtocol

getProtocol

withProtocol

withProtocol

setTimeoutMillis

getTimeoutMillis

withTimeoutMillis

setUnhealthyThreshold

getUnhealthyThreshold

withUnhealthyThreshold

toString

equals

hashCode

clone

marshall