Package org.cdk8s.plus28

Interface HttpGetProbeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ProbeOptions

All Known Implementing Classes:

HttpGetProbeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-03T12:13:25.546Z")
@Stability(Stable)
public interface HttpGetProbeOptions
extends software.amazon.jsii.JsiiSerializable, ProbeOptions

Options for Probe.fromHttpGet().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpGetProbeOptions.Builder	builder()
default String	getHost()	The host name to connect to on the container.
default Number	getPort()	The TCP port to use when sending the GET request.
default ConnectionScheme	getScheme()	Scheme to use for connecting to the host (HTTP or HTTPS).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface org.cdk8s.plus28.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 use when sending the GET request.

Default: - defaults to `container.port`.

getScheme

@Stability(Stable)
@Nullable
default ConnectionScheme getScheme()

Scheme to use for connecting to the host (HTTP or HTTPS).

Default: ConnectionScheme.HTTP

builder

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

Returns:

a HttpGetProbeOptions.Builder of HttpGetProbeOptions