HttpVirtualNodeListenerOptions

All Known Implementing Classes:: HttpVirtualNodeListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.622Z")
public interface HttpVirtualNodeListenerOptions

Represent the HTTP Node Listener prorperty.

Example:

 Mesh mesh;
 Vpc vpc = new Vpc(this, "vpc");
 PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
         .vpc(vpc)
         .name("domain.local")
         .build();
 Service service = namespace.createService("Svc");
 VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .port(8081)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .healthyThreshold(3)
                         .interval(Duration.seconds(5)) // minimum
                         .path("/health-check-path")
                         .timeout(Duration.seconds(2)) // minimum
                         .unhealthyThreshold(2)
                         .build()))
                 .build())))
         .accessLog(AccessLog.fromFilePath("/dev/stdout"))
         .build());

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`HttpVirtualNodeListenerOptions.Builder` A builder for `HttpVirtualNodeListenerOptions`
`static class`	`HttpVirtualNodeListenerOptions.Jsii$Proxy` An implementation for `HttpVirtualNodeListenerOptions`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static HttpVirtualNodeListenerOptions.Builder`	`builder()`
`default HttpConnectionPool`	`getConnectionPool()` Connection pool for http listeners.
`default HealthCheck`	`getHealthCheck()` The health check information for the listener.
`default OutlierDetection`	`getOutlierDetection()` Represents the configuration for enabling outlier detection.
`default java.lang.Number`	`getPort()` Port to listen for connections on.
`default HttpTimeout`	`getTimeout()` Timeout for HTTP protocol.
`default ListenerTlsOptions`	`getTls()` Represents the configuration for enabling TLS on a listener.

- Method Detail
  - getConnectionPool
```
default HttpConnectionPool getConnectionPool()
```
    Connection pool for http listeners.
    Default: - None
  - getHealthCheck
```
default HealthCheck getHealthCheck()
```
    The health check information for the listener.
    Default: - no healthcheck
  - getOutlierDetection
```
default OutlierDetection getOutlierDetection()
```
    Represents the configuration for enabling outlier detection.
    Default: - none
  - getPort
```
default java.lang.Number getPort()
```
    Port to listen for connections on.
    Default: - 8080
  - getTimeout
```
default HttpTimeout getTimeout()
```
    Timeout for HTTP protocol.
    Default: - None
  - getTls
```
default ListenerTlsOptions getTls()
```
    Represents the configuration for enabling TLS on a listener.
    Default: - none
  - builder
```
static HttpVirtualNodeListenerOptions.Builder builder()
```
    Returns:
    
    a HttpVirtualNodeListenerOptions.Builder of HttpVirtualNodeListenerOptions

Interface HttpVirtualNodeListenerOptions

Nested Class Summary

Method Summary

Method Detail

getConnectionPool

getHealthCheck

getOutlierDetection

getPort

getTimeout

getTls

builder