Package io.fabric8.kubernetes.api.model.networking.v1

Class IngressSpec

java.lang.Object

io.fabric8.kubernetes.api.model.networking.v1.IngressSpec

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<IngressSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class IngressSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<IngressSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

IngressSpec describes the Ingress the user wishes to exist.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
IngressSpec()	No args constructor for use in serialization
IngressSpec(IngressBackend defaultBackend, String ingressClassName, List<IngressRule> rules, List<IngressTLS> tls)

Method Summary

Modifier and Type	Method	Description
IngressSpecBuilder	edit()
Map<String,Object>	getAdditionalProperties()
IngressBackend	getDefaultBackend()	IngressSpec describes the Ingress the user wishes to exist.
String	getIngressClassName()	ingressClassName is the name of an IngressClass cluster resource.
List<IngressRule>	getRules()	rules is a list of host rules used to configure the Ingress.
List<IngressTLS>	getTls()	tls represents the TLS configuration.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setDefaultBackend(IngressBackend defaultBackend)	IngressSpec describes the Ingress the user wishes to exist.
void	setIngressClassName(String ingressClassName)	ingressClassName is the name of an IngressClass cluster resource.
void	setRules(List<IngressRule> rules)	rules is a list of host rules used to configure the Ingress.
void	setTls(List<IngressTLS> tls)	tls represents the TLS configuration.
IngressSpecBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

IngressSpec

public IngressSpec()

No args constructor for use in serialization

IngressSpec

public IngressSpec(IngressBackend defaultBackend,
                   String ingressClassName,
                   List<IngressRule> rules,
                   List<IngressTLS> tls)

Method Detail

getDefaultBackend

public IngressBackend getDefaultBackend()

IngressSpec describes the Ingress the user wishes to exist.

setDefaultBackend

public void setDefaultBackend(IngressBackend defaultBackend)

IngressSpec describes the Ingress the user wishes to exist.

getIngressClassName

public String getIngressClassName()

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.

setIngressClassName

public void setIngressClassName(String ingressClassName)

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.

getRules

public List<IngressRule> getRules()

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.

setRules

public void setRules(List<IngressRule> rules)

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.

getTls

public List<IngressTLS> getTls()

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.

setTls

public void setTls(List<IngressTLS> tls)

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.

edit

public IngressSpecBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<IngressSpecBuilder>

toBuilder

public IngressSpecBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)