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

Class PolicyAncestorStatus

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<PolicyAncestorStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class PolicyAncestorStatus
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<PolicyAncestorStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    PolicyAncestorStatus describes the status of a route with respect to an associated Ancestor.


    Ancestors refer to objects that are either the Target of a policy or above it in terms of object hierarchy. For example, if a policy targets a Service, the Policy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and the GatewayClass. Almost always, in this hierarchy, the Gateway will be the most useful object to place Policy status on, so we recommend that implementations SHOULD use Gateway as the PolicyAncestorStatus object unless the designers have a _very_ good reason otherwise.


    In the context of policy attachment, the Ancestor is used to distinguish which resource results in a distinct application of this policy. For example, if a policy targets a Service, it may have a distinct result per attached Gateway.


    Policies targeting the same resource may have different effects depending on the ancestors of those resources. For example, different Gateways targeting the same Service may have different capabilities, especially if they have different underlying implementations.


    For example, in BackendTLSPolicy, the Policy attaches to a Service that is used as a backend in a HTTPRoute that is itself attached to a Gateway. In this case, the relevant object for status is the Gateway, and that is the ancestor object referred to in this status.


    Note that a parent is also an ancestor, so for objects where the parent is the relevant object for status, this struct SHOULD still be used.


    This struct is intended to be used in a slice that's effectively a map, with a composite key made up of the AncestorRef and the ControllerName.

    See Also:
    Serialized Form

    • Constructor Detail

      • PolicyAncestorStatus

        public PolicyAncestorStatus()
        No args constructor for use in serialization

      • PolicyAncestorStatus

        public PolicyAncestorStatus​(ParentReference ancestorRef,
                            List<io.fabric8.kubernetes.api.model.Condition> conditions,
                            String controllerName)

    • Method Detail

      • getAncestorRef

        public ParentReference getAncestorRef()
        PolicyAncestorStatus describes the status of a route with respect to an associated Ancestor.


        Ancestors refer to objects that are either the Target of a policy or above it in terms of object hierarchy. For example, if a policy targets a Service, the Policy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and the GatewayClass. Almost always, in this hierarchy, the Gateway will be the most useful object to place Policy status on, so we recommend that implementations SHOULD use Gateway as the PolicyAncestorStatus object unless the designers have a _very_ good reason otherwise.


        In the context of policy attachment, the Ancestor is used to distinguish which resource results in a distinct application of this policy. For example, if a policy targets a Service, it may have a distinct result per attached Gateway.


        Policies targeting the same resource may have different effects depending on the ancestors of those resources. For example, different Gateways targeting the same Service may have different capabilities, especially if they have different underlying implementations.


        For example, in BackendTLSPolicy, the Policy attaches to a Service that is used as a backend in a HTTPRoute that is itself attached to a Gateway. In this case, the relevant object for status is the Gateway, and that is the ancestor object referred to in this status.


        Note that a parent is also an ancestor, so for objects where the parent is the relevant object for status, this struct SHOULD still be used.


        This struct is intended to be used in a slice that's effectively a map, with a composite key made up of the AncestorRef and the ControllerName.

      • setAncestorRef

        public void setAncestorRef​(ParentReference ancestorRef)
        PolicyAncestorStatus describes the status of a route with respect to an associated Ancestor.


        Ancestors refer to objects that are either the Target of a policy or above it in terms of object hierarchy. For example, if a policy targets a Service, the Policy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and the GatewayClass. Almost always, in this hierarchy, the Gateway will be the most useful object to place Policy status on, so we recommend that implementations SHOULD use Gateway as the PolicyAncestorStatus object unless the designers have a _very_ good reason otherwise.


        In the context of policy attachment, the Ancestor is used to distinguish which resource results in a distinct application of this policy. For example, if a policy targets a Service, it may have a distinct result per attached Gateway.


        Policies targeting the same resource may have different effects depending on the ancestors of those resources. For example, different Gateways targeting the same Service may have different capabilities, especially if they have different underlying implementations.


        For example, in BackendTLSPolicy, the Policy attaches to a Service that is used as a backend in a HTTPRoute that is itself attached to a Gateway. In this case, the relevant object for status is the Gateway, and that is the ancestor object referred to in this status.


        Note that a parent is also an ancestor, so for objects where the parent is the relevant object for status, this struct SHOULD still be used.


        This struct is intended to be used in a slice that's effectively a map, with a composite key made up of the AncestorRef and the ControllerName.

      • getConditions

        public List<io.fabric8.kubernetes.api.model.Condition> getConditions()
        Conditions describes the status of the Policy with respect to the given Ancestor.


        <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 describes the status of the Policy with respect to the given Ancestor.


        <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>

      • getControllerName

        public String getControllerName()
        ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass.


        Example: "example.net/gateway-controller".


        The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).


        Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary.

      • setControllerName

        public void setControllerName​(String controllerName)
        ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass.


        Example: "example.net/gateway-controller".


        The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).


        Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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