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

Class ListenerSet

java.lang.Object

io.fabric8.kubernetes.api.model.gatewayapi.v1.ListenerSet

All Implemented Interfaces:

Editable<ListenerSetBuilder>, HasMetadata, KubernetesResource, Namespaced, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ListenerSet
extends Object
implements Editable<ListenerSetBuilder>, HasMetadata, Namespaced

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

See Also:

Serialized Form

Field Summary

Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
ListenerSet()	No args constructor for use in serialization
ListenerSet(String apiVersion, String kind, ObjectMeta metadata, ListenerSetSpec spec, ListenerSetStatus status)

Method Summary

Modifier and Type	Method	Description
ListenerSetBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getApiVersion()	APIVersion defines the versioned schema of this representation of an object.
String	getKind()	Kind is a string value representing the REST resource this object represents.
ObjectMeta	getMetadata()	ListenerSet defines a set of additional listeners to attach to an existing Gateway.
ListenerSetSpec	getSpec()	ListenerSet defines a set of additional listeners to attach to an existing Gateway.
ListenerSetStatus	getStatus()	ListenerSet defines a set of additional listeners to attach to an existing Gateway.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setApiVersion(String apiVersion)	APIVersion defines the versioned schema of this representation of an object.
void	setKind(String kind)	Kind is a string value representing the REST resource this object represents.
void	setMetadata(ObjectMeta metadata)	ListenerSet defines a set of additional listeners to attach to an existing Gateway.
void	setSpec(ListenerSetSpec spec)	ListenerSet defines a set of additional listeners to attach to an existing Gateway.
void	setStatus(ListenerSetStatus status)	ListenerSet defines a set of additional listeners to attach to an existing Gateway.
ListenerSetBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

addFinalizer, addOwnerReference, addOwnerReference, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, getPlural, getSingular, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, isSameResource, isSameResource, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference

Constructor Detail

ListenerSet

public ListenerSet()

No args constructor for use in serialization

ListenerSet

public ListenerSet(String apiVersion,
                   String kind,
                   ObjectMeta metadata,
                   ListenerSetSpec spec,
                   ListenerSetStatus status)

Method Detail

getApiVersion

public String getApiVersion()

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Specified by:

getApiVersion in interface HasMetadata

setApiVersion

public void setApiVersion(String apiVersion)

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Specified by:

setApiVersion in interface HasMetadata

getKind

public String getKind()

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Specified by:

getKind in interface HasMetadata

setKind

public void setKind(String kind)

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

getMetadata

public ObjectMeta getMetadata()

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

Specified by:

getMetadata in interface HasMetadata

setMetadata

public void setMetadata(ObjectMeta metadata)

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

Specified by:

setMetadata in interface HasMetadata

getSpec

public ListenerSetSpec getSpec()

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

setSpec

public void setSpec(ListenerSetSpec spec)

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

getStatus

public ListenerSetStatus getStatus()

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

setStatus

public void setStatus(ListenerSetStatus status)

ListenerSet defines a set of additional listeners to attach to an existing Gateway. This resource provides a mechanism to merge multiple listeners into a single Gateway.

The parent Gateway must explicitly allow ListenerSet attachment through its AllowedListeners configuration. By default, Gateways do not allow ListenerSet attachment.

Routes can attach to a ListenerSet by specifying it as a parentRef, and can optionally target specific listeners using the sectionName field.

Policy Attachment: - Policies that attach to a ListenerSet apply to all listeners defined in that resource - Policies do not impact listeners in the parent Gateway - Different ListenerSets attached to the same Gateway can have different policies - If an implementation cannot apply a policy to specific listeners, it should reject the policy

ReferenceGrant Semantics: - ReferenceGrants applied to a Gateway are not inherited by child ListenerSets - ReferenceGrants applied to a ListenerSet do not grant permission to the parent Gateway's listeners - A ListenerSet can reference secrets/backends in its own namespace without a ReferenceGrant

Gateway Integration:

- The parent Gateway's status will include "AttachedListenerSets"

which is the count of ListenerSets that have successfully attached to a Gateway

A ListenerSet is successfully attached to a Gateway when all the following conditions are met:

- The ListenerSet is selected by the Gateway's AllowedListeners field

- The ListenerSet has a valid ParentRef selecting the Gateway

- The ListenerSet's status has the condition "Accepted: true"

edit

public ListenerSetBuilder edit()

Specified by:

edit in interface Editable<ListenerSetBuilder>

toBuilder

public ListenerSetBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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