io.k8s.api.networking.v1.IngressSpec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bl-k8s130 Show documentation

Programmatic resource management for Kubernetes

There is a newer version: 1.30.4

package io.k8s.api.networking.v1;

import java.lang.String;
import java.util.List;

/**
 * IngressSpec describes the Ingress the user wishes to exist.
 */
public class IngressSpec {
  public IngressBackend defaultBackend;

  public String ingressClassName;

  public List rules;

  public List tls;

  public IngressSpec defaultBackend(IngressBackend defaultBackend) {
    this.defaultBackend = defaultBackend;
    return this;
  }

  /**
   * ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
   */
  public IngressSpec ingressClassName(String ingressClassName) {
    this.ingressClassName = ingressClassName;
    return this;
  }

  /**
   * rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
   */
  public IngressSpec rules(List rules) {
    this.rules = rules;
    return this;
  }

  /**
   * tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
   */
  public IngressSpec tls(List tls) {
    this.tls = tls;
    return this;
  }

  public static IngressSpec ingressSpec() {
    return new IngressSpec();
  }
}