AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy Class Reference

#include <VirtualGatewayHealthCheckPolicy.h>

Public Member Functions

 VirtualGatewayHealthCheckPolicy ()
 
 VirtualGatewayHealthCheckPolicy (Aws::Utils::Json::JsonView jsonValue)
 
VirtualGatewayHealthCheckPolicyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetHealthyThreshold () const
 
bool HealthyThresholdHasBeenSet () const
 
void SetHealthyThreshold (int value)
 
VirtualGatewayHealthCheckPolicyWithHealthyThreshold (int value)
 
long long GetIntervalMillis () const
 
bool IntervalMillisHasBeenSet () const
 
void SetIntervalMillis (long long value)
 
VirtualGatewayHealthCheckPolicyWithIntervalMillis (long long value)
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
VirtualGatewayHealthCheckPolicyWithPath (const Aws::String &value)
 
VirtualGatewayHealthCheckPolicyWithPath (Aws::String &&value)
 
VirtualGatewayHealthCheckPolicyWithPath (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
VirtualGatewayHealthCheckPolicyWithPort (int value)
 
const VirtualGatewayPortProtocolGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const VirtualGatewayPortProtocol &value)
 
void SetProtocol (VirtualGatewayPortProtocol &&value)
 
VirtualGatewayHealthCheckPolicyWithProtocol (const VirtualGatewayPortProtocol &value)
 
VirtualGatewayHealthCheckPolicyWithProtocol (VirtualGatewayPortProtocol &&value)
 
long long GetTimeoutMillis () const
 
bool TimeoutMillisHasBeenSet () const
 
void SetTimeoutMillis (long long value)
 
VirtualGatewayHealthCheckPolicyWithTimeoutMillis (long long value)
 
int GetUnhealthyThreshold () const
 
bool UnhealthyThresholdHasBeenSet () const
 
void SetUnhealthyThreshold (int value)
 
VirtualGatewayHealthCheckPolicyWithUnhealthyThreshold (int value)
 

Detailed Description

An object that represents the health check policy for a virtual gateway's listener.

See Also:

AWS API Reference

Definition at line 33 of file VirtualGatewayHealthCheckPolicy.h.

Constructor & Destructor Documentation

◆ VirtualGatewayHealthCheckPolicy() [1/2]

Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::VirtualGatewayHealthCheckPolicy ( )

◆ VirtualGatewayHealthCheckPolicy() [2/2]

Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::VirtualGatewayHealthCheckPolicy ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetHealthyThreshold()

int Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetHealthyThreshold ( ) const
inline

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

Definition at line 46 of file VirtualGatewayHealthCheckPolicy.h.

◆ GetIntervalMillis()

long long Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetIntervalMillis ( ) const
inline

The time period in milliseconds between each health check execution.

Definition at line 70 of file VirtualGatewayHealthCheckPolicy.h.

◆ GetPath()

const Aws::String& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetPath ( ) const
inline

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.

Definition at line 93 of file VirtualGatewayHealthCheckPolicy.h.

◆ GetPort()

int Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetPort ( ) const
inline

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

Definition at line 149 of file VirtualGatewayHealthCheckPolicy.h.

◆ GetProtocol()

const VirtualGatewayPortProtocol& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetProtocol ( ) const
inline

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Definition at line 176 of file VirtualGatewayHealthCheckPolicy.h.

◆ GetTimeoutMillis()

long long Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetTimeoutMillis ( ) const
inline

The amount of time to wait when receiving a response from the health check, in milliseconds.

Definition at line 223 of file VirtualGatewayHealthCheckPolicy.h.

◆ GetUnhealthyThreshold()

int Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::GetUnhealthyThreshold ( ) const
inline

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

Definition at line 248 of file VirtualGatewayHealthCheckPolicy.h.

◆ HealthyThresholdHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::HealthyThresholdHasBeenSet ( ) const
inline

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

Definition at line 52 of file VirtualGatewayHealthCheckPolicy.h.

◆ IntervalMillisHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::IntervalMillisHasBeenSet ( ) const
inline

The time period in milliseconds between each health check execution.

Definition at line 75 of file VirtualGatewayHealthCheckPolicy.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::Jsonize ( ) const

◆ operator=()

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PathHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::PathHasBeenSet ( ) const
inline

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.

Definition at line 100 of file VirtualGatewayHealthCheckPolicy.h.

◆ PortHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::PortHasBeenSet ( ) const
inline

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

Definition at line 155 of file VirtualGatewayHealthCheckPolicy.h.

◆ ProtocolHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::ProtocolHasBeenSet ( ) const
inline

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Definition at line 184 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetHealthyThreshold()

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetHealthyThreshold ( int  value)
inline

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

Definition at line 58 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetIntervalMillis()

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetIntervalMillis ( long long  value)
inline

The time period in milliseconds between each health check execution.

Definition at line 80 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetPath() [1/3]

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetPath ( const Aws::String value)
inline

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.

Definition at line 107 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetPath() [2/3]

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetPath ( Aws::String &&  value)
inline

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.

Definition at line 114 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetPath() [3/3]

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetPath ( const char *  value)
inline

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.

Definition at line 121 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetPort()

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetPort ( int  value)
inline

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

Definition at line 161 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetProtocol() [1/2]

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetProtocol ( const VirtualGatewayPortProtocol value)
inline

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Definition at line 192 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetProtocol() [2/2]

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetProtocol ( VirtualGatewayPortProtocol &&  value)
inline

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Definition at line 200 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetTimeoutMillis()

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetTimeoutMillis ( long long  value)
inline

The amount of time to wait when receiving a response from the health check, in milliseconds.

Definition at line 235 of file VirtualGatewayHealthCheckPolicy.h.

◆ SetUnhealthyThreshold()

void Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::SetUnhealthyThreshold ( int  value)
inline

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

Definition at line 260 of file VirtualGatewayHealthCheckPolicy.h.

◆ TimeoutMillisHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::TimeoutMillisHasBeenSet ( ) const
inline

The amount of time to wait when receiving a response from the health check, in milliseconds.

Definition at line 229 of file VirtualGatewayHealthCheckPolicy.h.

◆ UnhealthyThresholdHasBeenSet()

bool Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::UnhealthyThresholdHasBeenSet ( ) const
inline

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

Definition at line 254 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithHealthyThreshold()

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithHealthyThreshold ( int  value)
inline

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

Definition at line 64 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithIntervalMillis()

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithIntervalMillis ( long long  value)
inline

The time period in milliseconds between each health check execution.

Definition at line 85 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithPath() [1/3]

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithPath ( const Aws::String value)
inline

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.

Definition at line 128 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithPath() [2/3]

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithPath ( Aws::String &&  value)
inline

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.

Definition at line 135 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithPath() [3/3]

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithPath ( const char *  value)
inline

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.

Definition at line 142 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithPort()

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithPort ( int  value)
inline

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

Definition at line 167 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithProtocol() [1/2]

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithProtocol ( const VirtualGatewayPortProtocol value)
inline

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Definition at line 208 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithProtocol() [2/2]

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithProtocol ( VirtualGatewayPortProtocol &&  value)
inline

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Definition at line 216 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithTimeoutMillis()

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithTimeoutMillis ( long long  value)
inline

The amount of time to wait when receiving a response from the health check, in milliseconds.

Definition at line 241 of file VirtualGatewayHealthCheckPolicy.h.

◆ WithUnhealthyThreshold()

VirtualGatewayHealthCheckPolicy& Aws::AppMesh::Model::VirtualGatewayHealthCheckPolicy::WithUnhealthyThreshold ( int  value)
inline

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

Definition at line 266 of file VirtualGatewayHealthCheckPolicy.h.


The documentation for this class was generated from the following file: