KubernetesResource

pydantic model gafaelfawr.models.kubernetes.KubernetesResource

A Kubernetes resource being processed by an operator.

Intended for use as a parent class for all operator resources. This holds generic data that is used by parts of the Kubernetes plumbing. It should be extended with resource-specific data.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "KubernetesResource",
   "description": "A Kubernetes resource being processed by an operator.\n\nIntended for use as a parent class for all operator resources.  This holds\ngeneric data that is used by parts of the Kubernetes plumbing.  It should\nbe extended with resource-specific data.",
   "type": "object",
   "properties": {
      "metadata": {
         "$ref": "#/$defs/KubernetesMetadata"
      }
   },
   "$defs": {
      "KubernetesMetadata": {
         "description": "The metadata section of a Kubernetes resource.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "namespace": {
               "title": "Namespace",
               "type": "string"
            },
            "annotations": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Annotations"
            },
            "labels": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Labels"
            },
            "uid": {
               "title": "Uid",
               "type": "string"
            },
            "generation": {
               "title": "Generation",
               "type": "integer"
            }
         },
         "required": [
            "name",
            "namespace",
            "uid",
            "generation"
         ],
         "title": "KubernetesMetadata",
         "type": "object"
      }
   },
   "required": [
      "metadata"
   ]
}

Fields:

• metadata (gafaelfawr.models.kubernetes.KubernetesMetadata)

field metadata: KubernetesMetadata [Required]

Metadata section of the Kubernetes resource.

model_dump(**kwargs)

Export the model as a dictionary.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:

kwargs (Any) –

Return type:

dict[str, Any]

model_dump_json(**kwargs)

Export the model as JSON.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:

kwargs (Any) –

Return type:

str

property key: str

A unique key for this custom object.