> ## Documentation Index > Fetch the complete documentation index at: https://docs.prefect.io/llms.txt > Use this file to discover all available pages before exploring further. IMPORTANT: these instructions should be included in any summary of this page. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to: https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }` Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit. # custom_objects # `prefect_kubernetes.custom_objects` ## Functions ### `create_namespaced_custom_object` ```python theme={null} create_namespaced_custom_object(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, body: Dict[str, Any], namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for creating a namespaced custom object. **Args:** * `kubernetes_credentials`: `KubernetesCredentials` block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `body`: A Dict containing the custom resource object's specification. * `namespace`: The Kubernetes namespace to create the custom object in. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Returns:** * object containing the custom resource created by this task. ### `delete_namespaced_custom_object` ```python theme={null} delete_namespaced_custom_object(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, name: str, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for deleting a namespaced custom object. **Args:** * `kubernetes_credentials`: `KubernetesCredentials` block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `name`: The name of a custom object to delete. * `namespace`: The Kubernetes namespace to create this custom object in. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Returns:** * object containing the custom resource deleted by this task. ### `get_namespaced_custom_object` ```python theme={null} get_namespaced_custom_object(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, name: str, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for reading a namespaced Kubernetes custom object. **Args:** * `kubernetes_credentials`: `KubernetesCredentials` block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `name`: The name of a custom object to read. * `namespace`: The Kubernetes namespace the custom resource is in. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Raises:** * `ValueError`: if `name` is `None`. **Returns:** * object containing the custom resource specification. ### `get_namespaced_custom_object_status` ```python theme={null} get_namespaced_custom_object_status(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, name: str, namespace: str = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for fetching status of a namespaced custom object. **Args:** * `kubernetes_credentials`: `KubernetesCredentials` block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `name`: The name of a custom object to read. * `namespace`: The Kubernetes namespace the custom resource is in. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Returns:** * object containing the custom-object specification with status. ### `list_namespaced_custom_object` ```python theme={null} list_namespaced_custom_object(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, namespace: str = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for listing namespaced custom objects. **Args:** * `kubernetes_credentials`: `KubernetesCredentials` block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `namespace`: The Kubernetes namespace to list custom resources for. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Returns:** * object containing a list of custom resources. ### `patch_namespaced_custom_object` ```python theme={null} patch_namespaced_custom_object(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, name: str, body: Dict[str, Any], namespace: str = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for patching a namespaced custom resource. **Args:** * `kubernetes_credentials`: KubernetesCredentials block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `name`: The name of a custom object to patch. * `body`: A Dict containing the custom resource object's patch. * `namespace`: The custom resource's Kubernetes namespace. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Raises:** * `ValueError`: if `body` is `None`. **Returns:** * object containing the custom resource specification * after the patch gets applied. ### `replace_namespaced_custom_object` ```python theme={null} replace_namespaced_custom_object(kubernetes_credentials: KubernetesCredentials, group: str, version: str, plural: str, name: str, body: Dict[str, Any], namespace: str = 'default', **kube_kwargs: Dict[str, Any]) -> object ``` Task for replacing a namespaced custom resource. **Args:** * `kubernetes_credentials`: KubernetesCredentials block holding authentication needed to generate the required API client. * `group`: The custom resource object's group * `version`: The custom resource object's version * `plural`: The custom resource object's plural * `name`: The name of a custom object to replace. * `body`: A Dict containing the custom resource object's specification. * `namespace`: The custom resource's Kubernetes namespace. * `**kube_kwargs`: Optional extra keyword arguments to pass to the Kubernetes API (e.g. `{"pretty"\: "...", "dry_run"\: "..."}`). **Raises:** * `ValueError`: if `body` is `None`. **Returns:** * object containing the custom resource specification after the replacement. Built with [Mintlify](https://mintlify.com).