Package org.cdk8s.plus28

Class HttpGetProbeOptions.Builder

java.lang.Object

org.cdk8s.plus28.HttpGetProbeOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpGetProbeOptions>

Enclosing interface:

HttpGetProbeOptions

@Stability(Stable)
public static final class HttpGetProbeOptions.Builder
extends Object
implements software.amazon.jsii.Builder<HttpGetProbeOptions>

A builder for HttpGetProbeOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpGetProbeOptions	build()	Builds the configured instance.
HttpGetProbeOptions.Builder	failureThreshold(Number failureThreshold)	Sets the value of ProbeOptions.getFailureThreshold()
HttpGetProbeOptions.Builder	host(String host)	Sets the value of HttpGetProbeOptions.getHost()
HttpGetProbeOptions.Builder	initialDelaySeconds(org.cdk8s.Duration initialDelaySeconds)	Sets the value of ProbeOptions.getInitialDelaySeconds()
HttpGetProbeOptions.Builder	periodSeconds(org.cdk8s.Duration periodSeconds)	Sets the value of ProbeOptions.getPeriodSeconds()
HttpGetProbeOptions.Builder	port(Number port)	Sets the value of HttpGetProbeOptions.getPort()
HttpGetProbeOptions.Builder	scheme(ConnectionScheme scheme)	Sets the value of HttpGetProbeOptions.getScheme()
HttpGetProbeOptions.Builder	successThreshold(Number successThreshold)	Sets the value of ProbeOptions.getSuccessThreshold()
HttpGetProbeOptions.Builder	timeoutSeconds(org.cdk8s.Duration timeoutSeconds)	Sets the value of ProbeOptions.getTimeoutSeconds()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

host

@Stability(Stable)
public HttpGetProbeOptions.Builder host(String host)

Sets the value of HttpGetProbeOptions.getHost()

Parameters:

host - The host name to connect to on the container.

Returns:

this

port

@Stability(Stable)
public HttpGetProbeOptions.Builder port(Number port)

Sets the value of HttpGetProbeOptions.getPort()

Parameters:

port - The TCP port to use when sending the GET request.

Returns:

this

scheme

@Stability(Stable)
public HttpGetProbeOptions.Builder scheme(ConnectionScheme scheme)

Sets the value of HttpGetProbeOptions.getScheme()

Parameters:

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

Returns:

this

failureThreshold

@Stability(Stable)
public HttpGetProbeOptions.Builder failureThreshold(Number failureThreshold)

Sets the value of ProbeOptions.getFailureThreshold()

Parameters:

failureThreshold - Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Returns:

this

initialDelaySeconds

@Stability(Stable)
public HttpGetProbeOptions.Builder initialDelaySeconds(org.cdk8s.Duration initialDelaySeconds)

Sets the value of ProbeOptions.getInitialDelaySeconds()

Parameters:

initialDelaySeconds - Number of seconds after the container has started before liveness probes are initiated.

Returns:

this

periodSeconds

@Stability(Stable)
public HttpGetProbeOptions.Builder periodSeconds(org.cdk8s.Duration periodSeconds)

Sets the value of ProbeOptions.getPeriodSeconds()

Parameters:

periodSeconds - How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Returns:

this

successThreshold

@Stability(Stable)
public HttpGetProbeOptions.Builder successThreshold(Number successThreshold)

Sets the value of ProbeOptions.getSuccessThreshold()

Parameters:

successThreshold - Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

Returns:

this

timeoutSeconds

@Stability(Stable)
public HttpGetProbeOptions.Builder timeoutSeconds(org.cdk8s.Duration timeoutSeconds)

Sets the value of ProbeOptions.getTimeoutSeconds()

Parameters:

timeoutSeconds - Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.

Returns:

this

build

@Stability(Stable)
public HttpGetProbeOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HttpGetProbeOptions>

Returns:

a new instance of HttpGetProbeOptions

Throws:

NullPointerException - if any required attribute was not provided