Package org.cdk8s.plus24.k8s

Class WebhookClientConfig.Builder

java.lang.Object

org.cdk8s.plus24.k8s.WebhookClientConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebhookClientConfig>

Enclosing interface:

WebhookClientConfig

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

A builder for WebhookClientConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebhookClientConfig	build()	Builds the configured instance.
WebhookClientConfig.Builder	caBundle(String caBundle)	Sets the value of WebhookClientConfig.getCaBundle()
WebhookClientConfig.Builder	service(ServiceReference service)	Sets the value of WebhookClientConfig.getService()
WebhookClientConfig.Builder	url(String url)	Sets the value of WebhookClientConfig.getUrl()

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

caBundle

@Stability(Stable)
public WebhookClientConfig.Builder caBundle(String caBundle)

Sets the value of WebhookClientConfig.getCaBundle()

Parameters:

caBundle - `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.

Returns:

this

service

@Stability(Stable)
public WebhookClientConfig.Builder service(ServiceReference service)

Sets the value of WebhookClientConfig.getService()

Parameters:

service - `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. If the webhook is running within the cluster, then you should use service.

Returns:

this

url

@Stability(Stable)
public WebhookClientConfig.Builder url(String url)

Sets the value of WebhookClientConfig.getUrl()

Parameters:

url - `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of url or service must be specified.

The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address.

Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.

The scheme must be "https"; the URL must begin with "https://".

A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.

Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.

Returns:

this

build

@Stability(Stable)
public WebhookClientConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WebhookClientConfig

Throws:

NullPointerException - if any required attribute was not provided