Package org.cdk8s.plus23

Class Probe

java.lang.Object

software.amazon.jsii.JsiiObject

org.cdk8s.plus23.Probe

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.61.0 (build abf4039)",
           date="2022-07-06T20:17:23.690Z")
@Stability(Stable)
public class Probe
extends software.amazon.jsii.JsiiObject

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Probe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Probe(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static Probe	fromCommand(List<String> command)	Defines a probe based on a command which is executed within the container.
static Probe	fromCommand(List<String> command, CommandProbeOptions options)	Defines a probe based on a command which is executed within the container.
static Probe	fromHttpGet(String path)	Defines a probe based on an HTTP GET request to the IP address of the container.
static Probe	fromHttpGet(String path, HttpGetProbeOptions options)	Defines a probe based on an HTTP GET request to the IP address of the container.
static Probe	fromTcpSocket()	Defines a probe based opening a connection to a TCP socket on the container.
static Probe	fromTcpSocket(TcpSocketProbeOptions options)	Defines a probe based opening a connection to a TCP socket on the container.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Probe

protected Probe(software.amazon.jsii.JsiiObjectRef objRef)

Probe

protected Probe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromCommand

@Stability(Stable)
@NotNull
public static Probe fromCommand(@NotNull
                                List<String> command,
                                @Nullable
                                CommandProbeOptions options)

Defines a probe based on a command which is executed within the container.

Parameters:

command - The command to execute. This parameter is required.

options - Options.

fromCommand

@Stability(Stable)
@NotNull
public static Probe fromCommand(@NotNull
                                List<String> command)

Defines a probe based on a command which is executed within the container.

Parameters:

command - The command to execute. This parameter is required.

fromHttpGet

@Stability(Stable)
@NotNull
public static Probe fromHttpGet(@NotNull
                                String path,
                                @Nullable
                                HttpGetProbeOptions options)

Defines a probe based on an HTTP GET request to the IP address of the container.

Parameters:

path - The URL path to hit. This parameter is required.

options - Options.

fromHttpGet

@Stability(Stable)
@NotNull
public static Probe fromHttpGet(@NotNull
                                String path)

Defines a probe based on an HTTP GET request to the IP address of the container.

Parameters:

path - The URL path to hit. This parameter is required.

fromTcpSocket

@Stability(Stable)
@NotNull
public static Probe fromTcpSocket(@Nullable
                                  TcpSocketProbeOptions options)

Defines a probe based opening a connection to a TCP socket on the container.

Parameters:

options - Options.

fromTcpSocket

@Stability(Stable)
@NotNull
public static Probe fromTcpSocket()

Defines a probe based opening a connection to a TCP socket on the container.