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

Class GatewayStatus

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<GatewayStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class GatewayStatus
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<GatewayStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    GatewayStatus defines the observed state of Gateway.
    See Also:
    Serialized Form

    • Constructor Detail

      • GatewayStatus

        public GatewayStatus()
        No args constructor for use in serialization

    • Method Detail

      • getAddresses

        public List<GatewayStatusAddress> getAddresses()
        Addresses lists the network addresses that have been bound to the Gateway.


        This list may differ from the addresses provided in the spec under some conditions:


        * no addresses are specified, all addresses are dynamically assigned

        * a combination of specified and dynamic addresses are assigned

        * a specified address was unusable (e.g. already in use)


        <gateway:validateIPAddress>

      • setAddresses

        public void setAddresses​(List<GatewayStatusAddress> addresses)
        Addresses lists the network addresses that have been bound to the Gateway.


        This list may differ from the addresses provided in the spec under some conditions:


        * no addresses are specified, all addresses are dynamically assigned

        * a combination of specified and dynamic addresses are assigned

        * a specified address was unusable (e.g. already in use)


        <gateway:validateIPAddress>

      • getConditions

        public List<io.fabric8.kubernetes.api.model.Condition> getConditions()
        Conditions describe the current conditions of the Gateway.


        Implementations should prefer to express Gateway conditions using the `GatewayConditionType` and `GatewayConditionReason` constants so that operators and tools can converge on a common vocabulary to describe Gateway state.


        Known condition types are:


        * "Accepted" * "Programmed" * "Ready"


        <gateway:util:excludeFromCRD> Notes for implementors:


        Conditions are a listType `map`, which means that they function like a map with a key of the `type` field _in the k8s apiserver_.


        This means that implementations must obey some rules when updating this section.


        * Implementations MUST perform a read-modify-write cycle on this field

        before modifying it. That is, when modifying this field, implementations

        must be confident they have fetched the most recent version of this field,

        and ensure that changes they make are on that recent version.

        * Implementations MUST NOT remove or reorder Conditions that they are not

        directly responsible for. For example, if an implementation sees a Condition

        with type `special.io/SomeField`, it MUST NOT remove, change or update that

        Condition.

        * Implementations MUST always _merge_ changes into Conditions of the same Type,

        rather than creating more than one Condition of the same Type.

        * Implementations MUST always update the `observedGeneration` field of the

        Condition to the `metadata.generation` of the Gateway at the time of update creation.

        * If the `observedGeneration` of a Condition is _greater than_ the value the

        implementation knows about, then it MUST NOT perform the update on that Condition,

        but must wait for a future reconciliation and status update. (The assumption is that

        the implementation's copy of the object is stale and an update will be re-triggered

        if relevant.)

        </gateway:util:excludeFromCRD>

      • setConditions

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


        Implementations should prefer to express Gateway conditions using the `GatewayConditionType` and `GatewayConditionReason` constants so that operators and tools can converge on a common vocabulary to describe Gateway state.


        Known condition types are:


        * "Accepted" * "Programmed" * "Ready"


        <gateway:util:excludeFromCRD> Notes for implementors:


        Conditions are a listType `map`, which means that they function like a map with a key of the `type` field _in the k8s apiserver_.


        This means that implementations must obey some rules when updating this section.


        * Implementations MUST perform a read-modify-write cycle on this field

        before modifying it. That is, when modifying this field, implementations

        must be confident they have fetched the most recent version of this field,

        and ensure that changes they make are on that recent version.

        * Implementations MUST NOT remove or reorder Conditions that they are not

        directly responsible for. For example, if an implementation sees a Condition

        with type `special.io/SomeField`, it MUST NOT remove, change or update that

        Condition.

        * Implementations MUST always _merge_ changes into Conditions of the same Type,

        rather than creating more than one Condition of the same Type.

        * Implementations MUST always update the `observedGeneration` field of the

        Condition to the `metadata.generation` of the Gateway at the time of update creation.

        * If the `observedGeneration` of a Condition is _greater than_ the value the

        implementation knows about, then it MUST NOT perform the update on that Condition,

        but must wait for a future reconciliation and status update. (The assumption is that

        the implementation's copy of the object is stale and an update will be re-triggered

        if relevant.)

        </gateway:util:excludeFromCRD>

      • getListeners

        public List<ListenerStatus> getListeners()
        Listeners provide status for each unique listener port defined in the Spec.

      • setListeners

        public void setListeners​(List<ListenerStatus> listeners)
        Listeners provide status for each unique listener port defined in the Spec.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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