org.cdk8s.plus31.k8s.WebhookClientConfig Maven / Gradle / Ivy
package org.cdk8s.plus31.k8s;
/**
* WebhookClientConfig contains the information to make a TLS connection with the webhook.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.757Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.k8s.WebhookClientConfig")
@software.amazon.jsii.Jsii.Proxy(WebhookClientConfig.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface WebhookClientConfig extends software.amazon.jsii.JsiiSerializable {
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getCaBundle() {
return null;
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus31.k8s.ServiceReference getService() {
return null;
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getUrl() {
return null;
}
/**
* @return a {@link Builder} of {@link WebhookClientConfig}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link WebhookClientConfig}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String caBundle;
org.cdk8s.plus31.k8s.ServiceReference service;
java.lang.String url;
/**
* Sets the value of {@link WebhookClientConfig#getCaBundle}
* @param 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.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder caBundle(java.lang.String caBundle) {
this.caBundle = caBundle;
return this;
}
/**
* Sets the value of {@link WebhookClientConfig#getService}
* @param 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.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder service(org.cdk8s.plus31.k8s.ServiceReference service) {
this.service = service;
return this;
}
/**
* Sets the value of {@link WebhookClientConfig#getUrl}
* @param 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.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder url(java.lang.String url) {
this.url = url;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link WebhookClientConfig}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public WebhookClientConfig build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link WebhookClientConfig}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements WebhookClientConfig {
private final java.lang.String caBundle;
private final org.cdk8s.plus31.k8s.ServiceReference service;
private final java.lang.String url;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.caBundle = software.amazon.jsii.Kernel.get(this, "caBundle", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.service = software.amazon.jsii.Kernel.get(this, "service", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.k8s.ServiceReference.class));
this.url = software.amazon.jsii.Kernel.get(this, "url", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.caBundle = builder.caBundle;
this.service = builder.service;
this.url = builder.url;
}
@Override
public final java.lang.String getCaBundle() {
return this.caBundle;
}
@Override
public final org.cdk8s.plus31.k8s.ServiceReference getService() {
return this.service;
}
@Override
public final java.lang.String getUrl() {
return this.url;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
if (this.getCaBundle() != null) {
data.set("caBundle", om.valueToTree(this.getCaBundle()));
}
if (this.getService() != null) {
data.set("service", om.valueToTree(this.getService()));
}
if (this.getUrl() != null) {
data.set("url", om.valueToTree(this.getUrl()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-31.k8s.WebhookClientConfig"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
WebhookClientConfig.Jsii$Proxy that = (WebhookClientConfig.Jsii$Proxy) o;
if (this.caBundle != null ? !this.caBundle.equals(that.caBundle) : that.caBundle != null) return false;
if (this.service != null ? !this.service.equals(that.service) : that.service != null) return false;
return this.url != null ? this.url.equals(that.url) : that.url == null;
}
@Override
public final int hashCode() {
int result = this.caBundle != null ? this.caBundle.hashCode() : 0;
result = 31 * result + (this.service != null ? this.service.hashCode() : 0);
result = 31 * result + (this.url != null ? this.url.hashCode() : 0);
return result;
}
}
}