Package io.kubernetes.client.extended.kubectl

Class Kubectl

java.lang.Object
io.kubernetes.client.extended.kubectl.Kubectl
public class Kubectl extends Object
Kubectl provides a set of helper functions that has the same functionalities as corresponding kubectl commands.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Kubectl.Executable<OUTPUT>
    Executable executes a kubectl helper.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Kubectl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlAnnotate<ApiType>
    annotate(Class<ApiType> apiTypeClass)
    Equivalence for `kubectl annotate`.
    static KubectlApiResources
    apiResources()
     
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlApply<ApiType>
    apply(Class<ApiType> clazz)
    Equivalent for `kubectl apply`
    static KubectlCopy
    copy()
    Equivalence for `kubectl cp`.
    static KubectlCordon
    cordon()
    Equivalent for `kubectl cordon`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlCreate<ApiType>
    create(Class<ApiType> clazz)
    Equivalent for `kubectl create`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlDelete<ApiType>
    delete(Class<ApiType> clazz)
    Equivalent for `kubectl delete`
    static KubectlDrain
    drain()
    Equivalent for `kubectl drain`
    static KubectlExec
    exec()
    Equivalent for `kubectl exec`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlGet<ApiType>
    get(Class<ApiType> apiTypeClass)
    Equivalent for `kubectl get`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlLabel<ApiType>
    label(Class<ApiType> apiTypeClass)
    Equivalence for `kubectl label`.
    static KubectlLog
    log()
    Equivalent for `kubectl log`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlPatch<ApiType>
    patch(Class<ApiType> apiTypeClass)
    Equivalent for `Kubectl patch`
    static KubectlPortForward
    portforward()
     
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlReplace<ApiType>
    replace(Class<ApiType> clazz)
    Equivalent for `kubectl replace`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlRollout<ApiType>
    rollout(Class<ApiType> apiTypeClass)
    Equivalent for `kubectl rollout history`
    static <ApiType extends io.kubernetes.client.common.KubernetesObject>
    KubectlScale<ApiType>
    scale(Class<ApiType> apiTypeClass)
    Equivalent for `kubectl scale`
    static KubectlTaint
    taint()
    Equivalence for `kubectl taint`.
    static <ApiType extends io.kubernetes.client.common.KubernetesObject, MetricsType>
    KubectlTop<ApiType,MetricsType>
    top(Class<ApiType> apiTypeClass, Class<MetricsType> metricsTypeClass)
    Equivalent for `kubectl top`
    static KubectlCordon
    uncordon()
    Equivalent for `kubectl uncordon`
    static KubectlVersion
    version()
    Equivalence for `kubectl version`.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Kubectl

      public Kubectl()

  • Method Details

    • get

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlGet<ApiType> get(Class<ApiType> apiTypeClass)
      Equivalent for `kubectl get`

    • create

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlCreate<ApiType> create(Class<ApiType> clazz)
      Equivalent for `kubectl create`

    • delete

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlDelete<ApiType> delete(Class<ApiType> clazz)
      Equivalent for `kubectl delete`

    • replace

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlReplace<ApiType> replace(Class<ApiType> clazz)
      Equivalent for `kubectl replace`

    • apply

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlApply<ApiType> apply(Class<ApiType> clazz)
      Equivalent for `kubectl apply`

    • drain

      public static KubectlDrain drain()
      Equivalent for `kubectl drain`

    • cordon

      public static KubectlCordon cordon()
      Equivalent for `kubectl cordon`

    • uncordon

      public static KubectlCordon uncordon()
      Equivalent for `kubectl uncordon`

    • top

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject, MetricsType> KubectlTop<ApiType,MetricsType> top(Class<ApiType> apiTypeClass, Class<MetricsType> metricsTypeClass)
      Equivalent for `kubectl top`
      Parameters:
      apiTypeClass - Must be either V1Pod.class or V1Node.class
      Returns:
      the kubectl top implementation

    • taint

      public static KubectlTaint taint()
      Equivalence for `kubectl taint`.

    • copy

      public static KubectlCopy copy()
      Equivalence for `kubectl cp`.
      Returns:
      the kubectl copy

    • label

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlLabel<ApiType> label(Class<ApiType> apiTypeClass)
      Equivalence for `kubectl label`.
      Type Parameters:
      ApiType - the target api type
      Parameters:
      apiTypeClass - the api type class
      Returns:
      the kubectl label

    • annotate

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlAnnotate<ApiType> annotate(Class<ApiType> apiTypeClass)
      Equivalence for `kubectl annotate`.
      Type Parameters:
      ApiType - the target api type
      Parameters:
      apiTypeClass - the api type class
      Returns:
      the kubectl annotation

    • version

      public static KubectlVersion version()
      Equivalence for `kubectl version`.
      Returns:
      the kubectl version

    • scale

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlScale<ApiType> scale(Class<ApiType> apiTypeClass)
      Equivalent for `kubectl scale`
      Type Parameters:
      ApiType - the target api type
      Parameters:
      apiTypeClass - the api type class
      Returns:
      the kubectl scale operator

    • rollout

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlRollout<ApiType> rollout(Class<ApiType> apiTypeClass)
      Equivalent for `kubectl rollout history`
      Type Parameters:
      ApiType - the target api type
      Parameters:
      apiTypeClass - the api type class
      Returns:
      the kubectl rollout history operator

    • exec

      public static KubectlExec exec()
      Equivalent for `kubectl exec`
      Returns:
      the kubectl exec operator

    • log

      public static KubectlLog log()
      Equivalent for `kubectl log`
      Returns:
      the kubectl log operator

    • portforward

      public static KubectlPortForward portforward()

    • apiResources

      public static KubectlApiResources apiResources()

    • patch

      public static <ApiType extends io.kubernetes.client.common.KubernetesObject> KubectlPatch<ApiType> patch(Class<ApiType> apiTypeClass)
      Equivalent for `Kubectl patch`
      Type Parameters:
      ApiType -
      Parameters:
      apiTypeClass -
      Returns: