Class CoreV1Api

Hierarchy

  • CoreV1Api

Constructors

constructor

Properties

_basePath _defaultHeaders _useQuerystring authentications interceptors

Accessors

basePath defaultHeaders useQuerystring

Methods

addInterceptor connectDeleteNamespacedPodProxy connectDeleteNamespacedPodProxyWithPath connectDeleteNamespacedServiceProxy connectDeleteNamespacedServiceProxyWithPath connectDeleteNodeProxy connectDeleteNodeProxyWithPath connectGetNamespacedPodAttach connectGetNamespacedPodExec connectGetNamespacedPodPortforward connectGetNamespacedPodProxy connectGetNamespacedPodProxyWithPath connectGetNamespacedServiceProxy connectGetNamespacedServiceProxyWithPath connectGetNodeProxy connectGetNodeProxyWithPath connectHeadNamespacedPodProxy connectHeadNamespacedPodProxyWithPath connectHeadNamespacedServiceProxy connectHeadNamespacedServiceProxyWithPath connectHeadNodeProxy connectHeadNodeProxyWithPath connectOptionsNamespacedPodProxy connectOptionsNamespacedPodProxyWithPath connectOptionsNamespacedServiceProxy connectOptionsNamespacedServiceProxyWithPath connectOptionsNodeProxy connectOptionsNodeProxyWithPath connectPatchNamespacedPodProxy connectPatchNamespacedPodProxyWithPath connectPatchNamespacedServiceProxy connectPatchNamespacedServiceProxyWithPath connectPatchNodeProxy connectPatchNodeProxyWithPath connectPostNamespacedPodAttach connectPostNamespacedPodExec connectPostNamespacedPodPortforward connectPostNamespacedPodProxy connectPostNamespacedPodProxyWithPath connectPostNamespacedServiceProxy connectPostNamespacedServiceProxyWithPath connectPostNodeProxy connectPostNodeProxyWithPath connectPutNamespacedPodProxy connectPutNamespacedPodProxyWithPath connectPutNamespacedServiceProxy connectPutNamespacedServiceProxyWithPath connectPutNodeProxy connectPutNodeProxyWithPath createNamespace createNamespacedBinding createNamespacedConfigMap createNamespacedEndpoints createNamespacedEvent createNamespacedLimitRange createNamespacedPersistentVolumeClaim createNamespacedPod createNamespacedPodBinding createNamespacedPodEviction createNamespacedPodTemplate createNamespacedReplicationController createNamespacedResourceQuota createNamespacedSecret createNamespacedService createNamespacedServiceAccount createNamespacedServiceAccountToken createNode createPersistentVolume deleteCollectionNamespacedConfigMap deleteCollectionNamespacedEndpoints deleteCollectionNamespacedEvent deleteCollectionNamespacedLimitRange deleteCollectionNamespacedPersistentVolumeClaim deleteCollectionNamespacedPod deleteCollectionNamespacedPodTemplate deleteCollectionNamespacedReplicationController deleteCollectionNamespacedResourceQuota deleteCollectionNamespacedSecret deleteCollectionNamespacedService deleteCollectionNamespacedServiceAccount deleteCollectionNode deleteCollectionPersistentVolume deleteNamespace deleteNamespacedConfigMap deleteNamespacedEndpoints deleteNamespacedEvent deleteNamespacedLimitRange deleteNamespacedPersistentVolumeClaim deleteNamespacedPod deleteNamespacedPodTemplate deleteNamespacedReplicationController deleteNamespacedResourceQuota deleteNamespacedSecret deleteNamespacedService deleteNamespacedServiceAccount deleteNode deletePersistentVolume getAPIResources listComponentStatus listConfigMapForAllNamespaces listEndpointsForAllNamespaces listEventForAllNamespaces listLimitRangeForAllNamespaces listNamespace listNamespacedConfigMap listNamespacedEndpoints listNamespacedEvent listNamespacedLimitRange listNamespacedPersistentVolumeClaim listNamespacedPod listNamespacedPodTemplate listNamespacedReplicationController listNamespacedResourceQuota listNamespacedSecret listNamespacedService listNamespacedServiceAccount listNode listPersistentVolume listPersistentVolumeClaimForAllNamespaces listPodForAllNamespaces listPodTemplateForAllNamespaces listReplicationControllerForAllNamespaces listResourceQuotaForAllNamespaces listSecretForAllNamespaces listServiceAccountForAllNamespaces listServiceForAllNamespaces patchNamespace patchNamespaceStatus patchNamespacedConfigMap patchNamespacedEndpoints patchNamespacedEvent patchNamespacedLimitRange patchNamespacedPersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus patchNamespacedPod patchNamespacedPodEphemeralcontainers patchNamespacedPodStatus patchNamespacedPodTemplate patchNamespacedReplicationController patchNamespacedReplicationControllerScale patchNamespacedReplicationControllerStatus patchNamespacedResourceQuota patchNamespacedResourceQuotaStatus patchNamespacedSecret patchNamespacedService patchNamespacedServiceAccount patchNamespacedServiceStatus patchNode patchNodeStatus patchPersistentVolume patchPersistentVolumeStatus readComponentStatus readNamespace readNamespaceStatus readNamespacedConfigMap readNamespacedEndpoints readNamespacedEvent readNamespacedLimitRange readNamespacedPersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus readNamespacedPod readNamespacedPodEphemeralcontainers readNamespacedPodLog readNamespacedPodStatus readNamespacedPodTemplate readNamespacedReplicationController readNamespacedReplicationControllerScale readNamespacedReplicationControllerStatus readNamespacedResourceQuota readNamespacedResourceQuotaStatus readNamespacedSecret readNamespacedService readNamespacedServiceAccount readNamespacedServiceStatus readNode readNodeStatus readPersistentVolume readPersistentVolumeStatus replaceNamespace replaceNamespaceFinalize replaceNamespaceStatus replaceNamespacedConfigMap replaceNamespacedEndpoints replaceNamespacedEvent replaceNamespacedLimitRange replaceNamespacedPersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus replaceNamespacedPod replaceNamespacedPodEphemeralcontainers replaceNamespacedPodStatus replaceNamespacedPodTemplate replaceNamespacedReplicationController replaceNamespacedReplicationControllerScale replaceNamespacedReplicationControllerStatus replaceNamespacedResourceQuota replaceNamespacedResourceQuotaStatus replaceNamespacedSecret replaceNamespacedService replaceNamespacedServiceAccount replaceNamespacedServiceStatus replaceNode replaceNodeStatus replacePersistentVolume replacePersistentVolumeStatus setApiKey setDefaultAuthentication

Constructors

constructor

Properties

Protected _basePath

_basePath: string = defaultBasePath

Protected _defaultHeaders

_defaultHeaders: any = {}

Protected _useQuerystring

_useQuerystring: boolean = false

Protected authentications

authentications: {
    BearerToken: ApiKeyAuth;
    default: Authentication;
} = ...

Type declaration

Protected interceptors

interceptors: Interceptor[] = []

Accessors

basePath

defaultHeaders

useQuerystring

Methods

addInterceptor

connectDeleteNamespacedPodProxy

  • connect DELETE requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectDeleteNamespacedPodProxyWithPath

  • connect DELETE requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectDeleteNamespacedServiceProxy

  • connect DELETE requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectDeleteNamespacedServiceProxyWithPath

  • connect DELETE requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectDeleteNodeProxy

  • connect DELETE requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectDeleteNodeProxyWithPath

  • connect DELETE requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedPodAttach

  • connect GET requests to attach of Pod

    Parameters

    • name: string

      name of the PodAttachOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional container: string

      The container in which to execute the command. Defaults to only container if there is only one container in the pod.

    • Optional stderr: boolean

      Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

    • Optional stdin: boolean

      Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

    • Optional stdout: boolean

      Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

    • Optional tty: boolean

      TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedPodExec

  • connect GET requests to exec of Pod

    Parameters

    • name: string

      name of the PodExecOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional command: string

      Command is the remote command to execute. argv array. Not executed within a shell.

    • Optional container: string

      Container in which to execute the command. Defaults to only container if there is only one container in the pod.

    • Optional stderr: boolean

      Redirect the standard error stream of the pod for this call.

    • Optional stdin: boolean

      Redirect the standard input stream of the pod for this call. Defaults to false.

    • Optional stdout: boolean

      Redirect the standard output stream of the pod for this call.

    • Optional tty: boolean

      TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedPodPortforward

  • connect GET requests to portforward of Pod

    Parameters

    • name: string

      name of the PodPortForwardOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional ports: number

      List of ports to forward Required when using WebSockets

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedPodProxy

  • connect GET requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedPodProxyWithPath

  • connect GET requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedServiceProxy

  • connect GET requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNamespacedServiceProxyWithPath

  • connect GET requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNodeProxy

  • connect GET requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectGetNodeProxyWithPath

  • connect GET requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectHeadNamespacedPodProxy

  • connect HEAD requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectHeadNamespacedPodProxyWithPath

  • connect HEAD requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectHeadNamespacedServiceProxy

  • connect HEAD requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectHeadNamespacedServiceProxyWithPath

  • connect HEAD requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectHeadNodeProxy

  • connect HEAD requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectHeadNodeProxyWithPath

  • connect HEAD requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectOptionsNamespacedPodProxy

  • connect OPTIONS requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectOptionsNamespacedPodProxyWithPath

  • connect OPTIONS requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectOptionsNamespacedServiceProxy

  • connect OPTIONS requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectOptionsNamespacedServiceProxyWithPath

  • connect OPTIONS requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectOptionsNodeProxy

  • connect OPTIONS requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectOptionsNodeProxyWithPath

  • connect OPTIONS requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPatchNamespacedPodProxy

  • connect PATCH requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPatchNamespacedPodProxyWithPath

  • connect PATCH requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPatchNamespacedServiceProxy

  • connect PATCH requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPatchNamespacedServiceProxyWithPath

  • connect PATCH requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPatchNodeProxy

  • connect PATCH requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPatchNodeProxyWithPath

  • connect PATCH requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedPodAttach

  • connect POST requests to attach of Pod

    Parameters

    • name: string

      name of the PodAttachOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional container: string

      The container in which to execute the command. Defaults to only container if there is only one container in the pod.

    • Optional stderr: boolean

      Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

    • Optional stdin: boolean

      Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

    • Optional stdout: boolean

      Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

    • Optional tty: boolean

      TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedPodExec

  • connect POST requests to exec of Pod

    Parameters

    • name: string

      name of the PodExecOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional command: string

      Command is the remote command to execute. argv array. Not executed within a shell.

    • Optional container: string

      Container in which to execute the command. Defaults to only container if there is only one container in the pod.

    • Optional stderr: boolean

      Redirect the standard error stream of the pod for this call.

    • Optional stdin: boolean

      Redirect the standard input stream of the pod for this call. Defaults to false.

    • Optional stdout: boolean

      Redirect the standard output stream of the pod for this call.

    • Optional tty: boolean

      TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedPodPortforward

  • connect POST requests to portforward of Pod

    Parameters

    • name: string

      name of the PodPortForwardOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional ports: number

      List of ports to forward Required when using WebSockets

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedPodProxy

  • connect POST requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedPodProxyWithPath

  • connect POST requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedServiceProxy

  • connect POST requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNamespacedServiceProxyWithPath

  • connect POST requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNodeProxy

  • connect POST requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPostNodeProxyWithPath

  • connect POST requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPutNamespacedPodProxy

  • connect PUT requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPutNamespacedPodProxyWithPath

  • connect PUT requests to proxy of Pod

    Parameters

    • name: string

      name of the PodProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to pod.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPutNamespacedServiceProxy

  • connect PUT requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional path: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPutNamespacedServiceProxyWithPath

  • connect PUT requests to proxy of Service

    Parameters

    • name: string

      name of the ServiceProxyOptions

    • namespace: string

      object name and auth scope, such as for teams and projects

    • path: string

      path to the resource

    • Optional path2: string

      Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPutNodeProxy

  • connect PUT requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • Optional path: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

connectPutNodeProxyWithPath

  • connect PUT requests to proxy of Node

    Parameters

    • name: string

      name of the NodeProxyOptions

    • path: string

      path to the resource

    • Optional path2: string

      Path is the URL path to use for the current proxy request to node.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

createNamespace

  • create a Namespace

    Parameters

    • body: V1Namespace
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

createNamespacedBinding

  • create a Binding

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Binding
    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Binding;
        response: IncomingMessage;
    }>

createNamespacedConfigMap

  • create a ConfigMap

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ConfigMap
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ConfigMap;
        response: IncomingMessage;
    }>

createNamespacedEndpoints

  • create Endpoints

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Endpoints
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Endpoints;
        response: IncomingMessage;
    }>

createNamespacedEvent

  • create an Event

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: CoreV1Event
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: CoreV1Event;
        response: IncomingMessage;
    }>

createNamespacedLimitRange

  • create a LimitRange

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1LimitRange
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1LimitRange;
        response: IncomingMessage;
    }>

createNamespacedPersistentVolumeClaim

  • create a PersistentVolumeClaim

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1PersistentVolumeClaim
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

createNamespacedPod

  • create a Pod

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Pod
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

createNamespacedPodBinding

  • create binding of a Pod

    Parameters

    • name: string

      name of the Binding

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Binding
    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Binding;
        response: IncomingMessage;
    }>

createNamespacedPodEviction

  • create eviction of a Pod

    Parameters

    • name: string

      name of the Eviction

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Eviction
    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Eviction;
        response: IncomingMessage;
    }>

createNamespacedPodTemplate

  • create a PodTemplate

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1PodTemplate
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplate;
        response: IncomingMessage;
    }>

createNamespacedReplicationController

  • create a ReplicationController

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ReplicationController
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

createNamespacedResourceQuota

  • create a ResourceQuota

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ResourceQuota
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

createNamespacedSecret

  • create a Secret

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Secret
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Secret;
        response: IncomingMessage;
    }>

createNamespacedService

  • create a Service

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Service
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

createNamespacedServiceAccount

  • create a ServiceAccount

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ServiceAccount
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccount;
        response: IncomingMessage;
    }>

createNamespacedServiceAccountToken

  • create token of a ServiceAccount

    Parameters

    • name: string

      name of the TokenRequest

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: AuthenticationV1TokenRequest
    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: AuthenticationV1TokenRequest;
        response: IncomingMessage;
    }>

createNode

  • create a Node

    Parameters

    • body: V1Node
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

createPersistentVolume

  • create a PersistentVolume

    Parameters

    • body: V1PersistentVolume
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedConfigMap

  • delete collection of ConfigMap

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedEndpoints

  • delete collection of Endpoints

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedEvent

  • delete collection of Event

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedLimitRange

  • delete collection of LimitRange

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedPersistentVolumeClaim

  • delete collection of PersistentVolumeClaim

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedPod

  • delete collection of Pod

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedPodTemplate

  • delete collection of PodTemplate

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedReplicationController

  • delete collection of ReplicationController

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedResourceQuota

  • delete collection of ResourceQuota

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedSecret

  • delete collection of Secret

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedService

  • delete collection of Service

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNamespacedServiceAccount

  • delete collection of ServiceAccount

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionNode

  • delete collection of Node

    Parameters

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteCollectionPersistentVolume

  • delete collection of PersistentVolume

    Parameters

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespace

  • delete a Namespace

    Parameters

    • name: string

      name of the Namespace

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedConfigMap

  • delete a ConfigMap

    Parameters

    • name: string

      name of the ConfigMap

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedEndpoints

  • delete Endpoints

    Parameters

    • name: string

      name of the Endpoints

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedEvent

  • delete an Event

    Parameters

    • name: string

      name of the Event

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedLimitRange

  • delete a LimitRange

    Parameters

    • name: string

      name of the LimitRange

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedPersistentVolumeClaim

  • delete a PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

deleteNamespacedPod

  • delete a Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

deleteNamespacedPodTemplate

  • delete a PodTemplate

    Parameters

    • name: string

      name of the PodTemplate

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplate;
        response: IncomingMessage;
    }>

deleteNamespacedReplicationController

  • delete a ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedResourceQuota

  • delete a ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

deleteNamespacedSecret

  • delete a Secret

    Parameters

    • name: string

      name of the Secret

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deleteNamespacedService

  • delete a Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

deleteNamespacedServiceAccount

  • delete a ServiceAccount

    Parameters

    • name: string

      name of the ServiceAccount

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccount;
        response: IncomingMessage;
    }>

deleteNode

  • delete a Node

    Parameters

    • name: string

      name of the Node

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Status;
        response: IncomingMessage;
    }>

deletePersistentVolume

  • delete a PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional gracePeriodSeconds: number

      The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    • Optional orphanDependents: boolean

      Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    • Optional propagationPolicy: string

      Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

    • Optional body: V1DeleteOptions
    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

getAPIResources

  • get available resources

    Parameters

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1APIResourceList;
        response: IncomingMessage;
    }>

listComponentStatus

  • list objects of kind ComponentStatus

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ComponentStatusList;
        response: IncomingMessage;
    }>

listConfigMapForAllNamespaces

  • list or watch objects of kind ConfigMap

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ConfigMapList;
        response: IncomingMessage;
    }>

listEndpointsForAllNamespaces

  • list or watch objects of kind Endpoints

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1EndpointsList;
        response: IncomingMessage;
    }>

listEventForAllNamespaces

  • list or watch objects of kind Event

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: CoreV1EventList;
        response: IncomingMessage;
    }>

listLimitRangeForAllNamespaces

  • list or watch objects of kind LimitRange

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1LimitRangeList;
        response: IncomingMessage;
    }>

listNamespace

  • list or watch objects of kind Namespace

    Parameters

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1NamespaceList;
        response: IncomingMessage;
    }>

listNamespacedConfigMap

  • list or watch objects of kind ConfigMap

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ConfigMapList;
        response: IncomingMessage;
    }>

listNamespacedEndpoints

  • list or watch objects of kind Endpoints

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1EndpointsList;
        response: IncomingMessage;
    }>

listNamespacedEvent

  • list or watch objects of kind Event

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: CoreV1EventList;
        response: IncomingMessage;
    }>

listNamespacedLimitRange

  • list or watch objects of kind LimitRange

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1LimitRangeList;
        response: IncomingMessage;
    }>

listNamespacedPersistentVolumeClaim

  • list or watch objects of kind PersistentVolumeClaim

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaimList;
        response: IncomingMessage;
    }>

listNamespacedPod

  • list or watch objects of kind Pod

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodList;
        response: IncomingMessage;
    }>

listNamespacedPodTemplate

  • list or watch objects of kind PodTemplate

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplateList;
        response: IncomingMessage;
    }>

listNamespacedReplicationController

  • list or watch objects of kind ReplicationController

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationControllerList;
        response: IncomingMessage;
    }>

listNamespacedResourceQuota

  • list or watch objects of kind ResourceQuota

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuotaList;
        response: IncomingMessage;
    }>

listNamespacedSecret

  • list or watch objects of kind Secret

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1SecretList;
        response: IncomingMessage;
    }>

listNamespacedService

  • list or watch objects of kind Service

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceList;
        response: IncomingMessage;
    }>

listNamespacedServiceAccount

  • list or watch objects of kind ServiceAccount

    Parameters

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccountList;
        response: IncomingMessage;
    }>

listNode

  • list or watch objects of kind Node

    Parameters

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1NodeList;
        response: IncomingMessage;
    }>

listPersistentVolume

  • list or watch objects of kind PersistentVolume

    Parameters

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeList;
        response: IncomingMessage;
    }>

listPersistentVolumeClaimForAllNamespaces

  • list or watch objects of kind PersistentVolumeClaim

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaimList;
        response: IncomingMessage;
    }>

listPodForAllNamespaces

  • list or watch objects of kind Pod

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodList;
        response: IncomingMessage;
    }>

listPodTemplateForAllNamespaces

  • list or watch objects of kind PodTemplate

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplateList;
        response: IncomingMessage;
    }>

listReplicationControllerForAllNamespaces

  • list or watch objects of kind ReplicationController

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationControllerList;
        response: IncomingMessage;
    }>

listResourceQuotaForAllNamespaces

  • list or watch objects of kind ResourceQuota

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuotaList;
        response: IncomingMessage;
    }>

listSecretForAllNamespaces

  • list or watch objects of kind Secret

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1SecretList;
        response: IncomingMessage;
    }>

listServiceAccountForAllNamespaces

  • list or watch objects of kind ServiceAccount

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccountList;
        response: IncomingMessage;
    }>

listServiceForAllNamespaces

  • list or watch objects of kind Service

    Parameters

    • Optional allowWatchBookmarks: boolean

      allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    • Optional _continue: string

      The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    • Optional fieldSelector: string

      A selector to restrict the list of returned objects by their fields. Defaults to everything.

    • Optional labelSelector: string

      A selector to restrict the list of returned objects by their labels. Defaults to everything.

    • Optional limit: number

      limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional resourceVersion: string

      resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional resourceVersionMatch: string

      resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

    • Optional sendInitialEvents: boolean

      `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise.

    • Optional timeoutSeconds: number

      Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    • Optional watch: boolean

      Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceList;
        response: IncomingMessage;
    }>

patchNamespace

  • partially update the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

patchNamespaceStatus

  • partially update status of the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

patchNamespacedConfigMap

  • partially update the specified ConfigMap

    Parameters

    • name: string

      name of the ConfigMap

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ConfigMap;
        response: IncomingMessage;
    }>

patchNamespacedEndpoints

  • partially update the specified Endpoints

    Parameters

    • name: string

      name of the Endpoints

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Endpoints;
        response: IncomingMessage;
    }>

patchNamespacedEvent

  • partially update the specified Event

    Parameters

    • name: string

      name of the Event

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: CoreV1Event;
        response: IncomingMessage;
    }>

patchNamespacedLimitRange

  • partially update the specified LimitRange

    Parameters

    • name: string

      name of the LimitRange

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1LimitRange;
        response: IncomingMessage;
    }>

patchNamespacedPersistentVolumeClaim

  • partially update the specified PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

patchNamespacedPersistentVolumeClaimStatus

  • partially update status of the specified PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

patchNamespacedPod

  • partially update the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

patchNamespacedPodEphemeralcontainers

  • partially update ephemeralcontainers of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

patchNamespacedPodStatus

  • partially update status of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

patchNamespacedPodTemplate

  • partially update the specified PodTemplate

    Parameters

    • name: string

      name of the PodTemplate

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplate;
        response: IncomingMessage;
    }>

patchNamespacedReplicationController

  • partially update the specified ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

patchNamespacedReplicationControllerScale

  • partially update scale of the specified ReplicationController

    Parameters

    • name: string

      name of the Scale

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Scale;
        response: IncomingMessage;
    }>

patchNamespacedReplicationControllerStatus

  • partially update status of the specified ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

patchNamespacedResourceQuota

  • partially update the specified ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

patchNamespacedResourceQuotaStatus

  • partially update status of the specified ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

patchNamespacedSecret

  • partially update the specified Secret

    Parameters

    • name: string

      name of the Secret

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Secret;
        response: IncomingMessage;
    }>

patchNamespacedService

  • partially update the specified Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

patchNamespacedServiceAccount

  • partially update the specified ServiceAccount

    Parameters

    • name: string

      name of the ServiceAccount

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccount;
        response: IncomingMessage;
    }>

patchNamespacedServiceStatus

  • partially update status of the specified Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

patchNode

  • partially update the specified Node

    Parameters

    • name: string

      name of the Node

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

patchNodeStatus

  • partially update status of the specified Node

    Parameters

    • name: string

      name of the Node

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

patchPersistentVolume

  • partially update the specified PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

patchPersistentVolumeStatus

  • partially update status of the specified PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • body: object
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional force: boolean

      Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

readComponentStatus

  • read the specified ComponentStatus

    Parameters

    • name: string

      name of the ComponentStatus

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ComponentStatus;
        response: IncomingMessage;
    }>

readNamespace

  • read the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

readNamespaceStatus

  • read status of the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

readNamespacedConfigMap

  • read the specified ConfigMap

    Parameters

    • name: string

      name of the ConfigMap

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ConfigMap;
        response: IncomingMessage;
    }>

readNamespacedEndpoints

  • read the specified Endpoints

    Parameters

    • name: string

      name of the Endpoints

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Endpoints;
        response: IncomingMessage;
    }>

readNamespacedEvent

  • read the specified Event

    Parameters

    • name: string

      name of the Event

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: CoreV1Event;
        response: IncomingMessage;
    }>

readNamespacedLimitRange

  • read the specified LimitRange

    Parameters

    • name: string

      name of the LimitRange

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1LimitRange;
        response: IncomingMessage;
    }>

readNamespacedPersistentVolumeClaim

  • read the specified PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

readNamespacedPersistentVolumeClaimStatus

  • read status of the specified PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

readNamespacedPod

  • read the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

readNamespacedPodEphemeralcontainers

  • read ephemeralcontainers of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

readNamespacedPodLog

  • read log of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional container: string

      The container for which to stream logs. Defaults to only container if there is one container in the pod.

    • Optional follow: boolean

      Follow the log stream of the pod. Defaults to false.

    • Optional insecureSkipTLSVerifyBackend: boolean

      insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver&#39;s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).

    • Optional limitBytes: number

      If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional previous: boolean

      Return previous terminated container logs. Defaults to false.

    • Optional sinceSeconds: number

      A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

    • Optional tailLines: number

      If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

    • Optional timestamps: boolean

      If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: string;
        response: IncomingMessage;
    }>

readNamespacedPodStatus

  • read status of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

readNamespacedPodTemplate

  • read the specified PodTemplate

    Parameters

    • name: string

      name of the PodTemplate

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplate;
        response: IncomingMessage;
    }>

readNamespacedReplicationController

  • read the specified ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

readNamespacedReplicationControllerScale

  • read scale of the specified ReplicationController

    Parameters

    • name: string

      name of the Scale

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Scale;
        response: IncomingMessage;
    }>

readNamespacedReplicationControllerStatus

  • read status of the specified ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

readNamespacedResourceQuota

  • read the specified ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

readNamespacedResourceQuotaStatus

  • read status of the specified ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

readNamespacedSecret

  • read the specified Secret

    Parameters

    • name: string

      name of the Secret

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Secret;
        response: IncomingMessage;
    }>

readNamespacedService

  • read the specified Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

readNamespacedServiceAccount

  • read the specified ServiceAccount

    Parameters

    • name: string

      name of the ServiceAccount

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccount;
        response: IncomingMessage;
    }>

readNamespacedServiceStatus

  • read status of the specified Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

readNode

  • read the specified Node

    Parameters

    • name: string

      name of the Node

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

readNodeStatus

  • read status of the specified Node

    Parameters

    • name: string

      name of the Node

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

readPersistentVolume

  • read the specified PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

readPersistentVolumeStatus

  • read status of the specified PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

replaceNamespace

  • replace the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • body: V1Namespace
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

replaceNamespaceFinalize

  • replace finalize of the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • body: V1Namespace
    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

replaceNamespaceStatus

  • replace status of the specified Namespace

    Parameters

    • name: string

      name of the Namespace

    • body: V1Namespace
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Namespace;
        response: IncomingMessage;
    }>

replaceNamespacedConfigMap

  • replace the specified ConfigMap

    Parameters

    • name: string

      name of the ConfigMap

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ConfigMap
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ConfigMap;
        response: IncomingMessage;
    }>

replaceNamespacedEndpoints

  • replace the specified Endpoints

    Parameters

    • name: string

      name of the Endpoints

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Endpoints
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Endpoints;
        response: IncomingMessage;
    }>

replaceNamespacedEvent

  • replace the specified Event

    Parameters

    • name: string

      name of the Event

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: CoreV1Event
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: CoreV1Event;
        response: IncomingMessage;
    }>

replaceNamespacedLimitRange

  • replace the specified LimitRange

    Parameters

    • name: string

      name of the LimitRange

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1LimitRange
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1LimitRange;
        response: IncomingMessage;
    }>

replaceNamespacedPersistentVolumeClaim

  • replace the specified PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1PersistentVolumeClaim
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

replaceNamespacedPersistentVolumeClaimStatus

  • replace status of the specified PersistentVolumeClaim

    Parameters

    • name: string

      name of the PersistentVolumeClaim

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1PersistentVolumeClaim
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolumeClaim;
        response: IncomingMessage;
    }>

replaceNamespacedPod

  • replace the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Pod
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

replaceNamespacedPodEphemeralcontainers

  • replace ephemeralcontainers of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Pod
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

replaceNamespacedPodStatus

  • replace status of the specified Pod

    Parameters

    • name: string

      name of the Pod

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Pod
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Pod;
        response: IncomingMessage;
    }>

replaceNamespacedPodTemplate

  • replace the specified PodTemplate

    Parameters

    • name: string

      name of the PodTemplate

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1PodTemplate
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PodTemplate;
        response: IncomingMessage;
    }>

replaceNamespacedReplicationController

  • replace the specified ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ReplicationController
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

replaceNamespacedReplicationControllerScale

  • replace scale of the specified ReplicationController

    Parameters

    • name: string

      name of the Scale

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Scale
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Scale;
        response: IncomingMessage;
    }>

replaceNamespacedReplicationControllerStatus

  • replace status of the specified ReplicationController

    Parameters

    • name: string

      name of the ReplicationController

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ReplicationController
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ReplicationController;
        response: IncomingMessage;
    }>

replaceNamespacedResourceQuota

  • replace the specified ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ResourceQuota
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

replaceNamespacedResourceQuotaStatus

  • replace status of the specified ResourceQuota

    Parameters

    • name: string

      name of the ResourceQuota

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ResourceQuota
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ResourceQuota;
        response: IncomingMessage;
    }>

replaceNamespacedSecret

  • replace the specified Secret

    Parameters

    • name: string

      name of the Secret

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Secret
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Secret;
        response: IncomingMessage;
    }>

replaceNamespacedService

  • replace the specified Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Service
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

replaceNamespacedServiceAccount

  • replace the specified ServiceAccount

    Parameters

    • name: string

      name of the ServiceAccount

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1ServiceAccount
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1ServiceAccount;
        response: IncomingMessage;
    }>

replaceNamespacedServiceStatus

  • replace status of the specified Service

    Parameters

    • name: string

      name of the Service

    • namespace: string

      object name and auth scope, such as for teams and projects

    • body: V1Service
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Service;
        response: IncomingMessage;
    }>

replaceNode

  • replace the specified Node

    Parameters

    • name: string

      name of the Node

    • body: V1Node
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

replaceNodeStatus

  • replace status of the specified Node

    Parameters

    • name: string

      name of the Node

    • body: V1Node
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1Node;
        response: IncomingMessage;
    }>

replacePersistentVolume

  • replace the specified PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • body: V1PersistentVolume
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

replacePersistentVolumeStatus

  • replace status of the specified PersistentVolume

    Parameters

    • name: string

      name of the PersistentVolume

    • body: V1PersistentVolume
    • Optional pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • Optional dryRun: string

      When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    • Optional fieldManager: string

      fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    • Optional fieldValidation: string

      fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1PersistentVolume;
        response: IncomingMessage;
    }>

setApiKey

setDefaultAuthentication

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc