Package org.cdk8s.plus20

Interface TcpSocketProbeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ProbeOptions

All Known Implementing Classes:

TcpSocketProbeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-09T22:09:14.880Z")
@Stability(Stable)
public interface TcpSocketProbeOptions
extends software.amazon.jsii.JsiiSerializable, ProbeOptions

Options for `Probe.fromTcpSocket()`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TcpSocketProbeOptions.Builder	A builder for TcpSocketProbeOptions
static class	TcpSocketProbeOptions.Jsii$Proxy	An implementation for TcpSocketProbeOptions

Method Summary

Modifier and Type	Method	Description
static TcpSocketProbeOptions.Builder	builder()
default String	getHost()	The host name to connect to on the container.
default Number	getPort()	The TCP port to connect to on the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface org.cdk8s.plus20.ProbeOptions

getFailureThreshold, getInitialDelaySeconds, getPeriodSeconds, getSuccessThreshold, getTimeoutSeconds

Method Detail

getHost

@Stability(Stable)
@Nullable
default String getHost()

The host name to connect to on the container.

Default: - defaults to the pod IP

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The TCP port to connect to on the container.

Default: - defaults to `container.port`.

builder

@Stability(Stable)
static TcpSocketProbeOptions.Builder builder()

Returns:

a TcpSocketProbeOptions.Builder of TcpSocketProbeOptions