Struct k8s_gateway_api::ParentReference

pub struct ParentReference {
    pub group: Option<Group>,
    pub kind: Option<Kind>,
    pub namespace: Option<Namespace>,
    pub name: ObjectName,
    pub section_name: Option<SectionName>,
    pub port: Option<PortNumber>,
}

ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with “Core” support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute.

The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.

Fields

group: Option<Group>

Group is the group of the referent.

Support: Core

kind: Option<Kind>

Kind is kind of the referent.

Support: Core (Gateway) Support: Custom (Other Resources)

namespace: Option<Namespace>

Namespace is the namespace of the referent. When unspecified (or empty string), this refers to the local namespace of the Route.

Support: Core

name: ObjectName

Name is the name of the referent.

Support: Core

section_name: Option<SectionName>

SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following:

• Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values.

Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted.

When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.

Support: Core

port: Option<PortNumber>

Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource:

• Gateway: All listeners listening on the specified port that also support this kind of Route(and select this Route). It’s not recommended to set Port unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values.

Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted.

For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway.

Support: Extended

Trait Implementations

impl Clone for ParentReference

fn clone(&self) -> ParentReference

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParentReference

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParentReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ParentReference

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<ParentReference> for ParentReference

fn eq(&self, other: &ParentReference) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ParentReference) -> bool

This method tests for !=.

impl Serialize for ParentReference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParentReference