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

Class ListenerStatus

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<ListenerStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ListenerStatus
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ListenerStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    ListenerStatus is the status associated with a Listener.
    See Also:
    Serialized Form

    • Constructor Detail

      • ListenerStatus

        public ListenerStatus()
        No args constructor for use in serialization

      • ListenerStatus

        public ListenerStatus​(Integer attachedRoutes,
                      List<io.fabric8.kubernetes.api.model.Condition> conditions,
                      String name,
                      List<RouteGroupKind> supportedKinds)

    • Method Detail

      • getAttachedRoutes

        public Integer getAttachedRoutes()
        AttachedRoutes represents the total number of Routes that have been successfully attached to this Listener.


        Successful attachment of a Route to a Listener is based solely on the combination of the AllowedRoutes field on the corresponding Listener and the Route's ParentRefs field. A Route is successfully attached to a Listener when it is selected by the Listener's AllowedRoutes field AND the Route has a valid ParentRef selecting the whole Gateway resource or a specific Listener as a parent resource (more detail on attachment semantics can be found in the documentation on the various Route kinds ParentRefs fields). Listener or Route status does not impact successful attachment, i.e. the AttachedRoutes field count MUST be set for Listeners with condition Accepted: false and MUST count successfully attached Routes that may themselves have Accepted: false conditions.


        Uses for this field include troubleshooting Route attachment and measuring blast radius/impact of changes to a Listener.

      • setAttachedRoutes

        public void setAttachedRoutes​(Integer attachedRoutes)
        AttachedRoutes represents the total number of Routes that have been successfully attached to this Listener.


        Successful attachment of a Route to a Listener is based solely on the combination of the AllowedRoutes field on the corresponding Listener and the Route's ParentRefs field. A Route is successfully attached to a Listener when it is selected by the Listener's AllowedRoutes field AND the Route has a valid ParentRef selecting the whole Gateway resource or a specific Listener as a parent resource (more detail on attachment semantics can be found in the documentation on the various Route kinds ParentRefs fields). Listener or Route status does not impact successful attachment, i.e. the AttachedRoutes field count MUST be set for Listeners with condition Accepted: false and MUST count successfully attached Routes that may themselves have Accepted: false conditions.


        Uses for this field include troubleshooting Route attachment and measuring blast radius/impact of changes to a Listener.

      • getConditions

        public List<io.fabric8.kubernetes.api.model.Condition> getConditions()
        Conditions describe the current condition of this listener.

      • setConditions

        public void setConditions​(List<io.fabric8.kubernetes.api.model.Condition> conditions)
        Conditions describe the current condition of this listener.

      • getName

        public String getName()
        Name is the name of the Listener that this status corresponds to.

      • setName

        public void setName​(String name)
        Name is the name of the Listener that this status corresponds to.

      • getSupportedKinds

        public List<RouteGroupKind> getSupportedKinds()
        SupportedKinds is the list indicating the Kinds supported by this listener. This MUST represent the kinds an implementation supports for that Listener configuration.


        If kinds are specified in Spec that are not supported, they MUST NOT appear in this list and an implementation MUST set the "ResolvedRefs" condition to "False" with the "InvalidRouteKinds" reason. If both valid and invalid Route kinds are specified, the implementation MUST reference the valid Route kinds that have been specified.

      • setSupportedKinds

        public void setSupportedKinds​(List<RouteGroupKind> supportedKinds)
        SupportedKinds is the list indicating the Kinds supported by this listener. This MUST represent the kinds an implementation supports for that Listener configuration.


        If kinds are specified in Spec that are not supported, they MUST NOT appear in this list and an implementation MUST set the "ResolvedRefs" condition to "False" with the "InvalidRouteKinds" reason. If both valid and invalid Route kinds are specified, the implementation MUST reference the valid Route kinds that have been specified.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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