GafaelfawrIngressPath

pydantic model gafaelfawr.models.kubernetes.GafaelfawrIngressPath

A path routing rule for an ingress.

Parameters:

data (Any)

Show JSON schema

{
   "title": "GafaelfawrIngressPath",
   "description": "A path routing rule for an ingress.",
   "type": "object",
   "properties": {
      "path": {
         "title": "Path",
         "type": "string"
      },
      "pathType": {
         "$ref": "#/$defs/PathType"
      },
      "backend": {
         "$ref": "#/$defs/GafaelfawrIngressPathBackend"
      }
   },
   "$defs": {
      "GafaelfawrIngressPathBackend": {
         "description": "Backend that serves a given path.",
         "properties": {
            "service": {
               "$ref": "#/$defs/GafaelfawrIngressPathService"
            }
         },
         "required": [
            "service"
         ],
         "title": "GafaelfawrIngressPathBackend",
         "type": "object"
      },
      "GafaelfawrIngressPathService": {
         "description": "Service that serves a given path.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "port": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GafaelfawrServicePortName"
                  },
                  {
                     "$ref": "#/$defs/GafaelfawrServicePortNumber"
                  }
               ],
               "title": "Port"
            }
         },
         "required": [
            "name",
            "port"
         ],
         "title": "GafaelfawrIngressPathService",
         "type": "object"
      },
      "GafaelfawrServicePortName": {
         "additionalProperties": false,
         "description": "Port for a service.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "name"
         ],
         "title": "GafaelfawrServicePortName",
         "type": "object"
      },
      "GafaelfawrServicePortNumber": {
         "additionalProperties": false,
         "description": "Port for a service.",
         "properties": {
            "number": {
               "title": "Number",
               "type": "integer"
            }
         },
         "required": [
            "number"
         ],
         "title": "GafaelfawrServicePortNumber",
         "type": "object"
      },
      "PathType": {
         "description": "Matching types for paths in ingress rules.",
         "enum": [
            "Exact",
            "ImplementationSpecific",
            "Prefix"
         ],
         "title": "PathType",
         "type": "string"
      }
   },
   "required": [
      "path",
      "pathType",
      "backend"
   ]
}

Fields:

• backend (gafaelfawr.models.kubernetes.GafaelfawrIngressPathBackend)

• path (str)

• pathType (gafaelfawr.models.kubernetes.PathType)

field backend: GafaelfawrIngressPathBackend [Required]

Backend that serves this path.

field path: str [Required]

Path match, interpreted based on the path_type field.

field pathType: PathType [Required] (name 'path_type')

How to match the specified path against the URL.

to_kubernetes()

Convert to the Kubernetes API object.

Return type:

V1HTTPIngressPath