Package io.fabric8.kubernetes.client

Interface KubernetesClient

    • Method Detail

      • apiextensions

        ApiextensionsAPIGroupDSL apiextensions()
        API entrypoint for apiextensions resources. Currently support both v1 and v1beta1
        Returns:
        ApiextensionsAPIGroupDSL which routes to v1 or v1beta1

      • certificateSigningRequests

        @Deprecated
NonNamespaceOperation<io.fabric8.kubernetes.api.model.certificates.v1beta1.CertificateSigningRequest,​io.fabric8.kubernetes.api.model.certificates.v1beta1.CertificateSigningRequestList,​Resource<io.fabric8.kubernetes.api.model.certificates.v1beta1.CertificateSigningRequest>> certificateSigningRequests()
        Deprecated.
        Use `client.certificates().v1beta1().certificateSigningRequest` instead
        API entrypoint for using CertificateSigningRequest(certificates.k8s.io/v1beta1)
        Returns:
        NonNamespaceOperation for CertificateSigningRequest class

      • customResources

        <T extends CustomResource> MixedOperation<T,​io.fabric8.kubernetes.api.model.KubernetesResourceList<T>,​Resource<T>> customResources​(Class<T> resourceType)
        Typed API for managing CustomResources. You would need to provide POJOs for CustomResource into this and with it you would be able to instantiate a client specific to CustomResource.

        Note: your CustomResource POJO (T in this context) must implement Namespaced if it is a namespace-scoped resource.

        Type Parameters:
        T - T type represents CustomResource type. If it's a namespaced resource, it must implement Namespaced
        Parameters:
        resourceType - Class for CustomResource
        Returns:
        returns a MixedOperation object with which you can do basic CustomResource operations

      • customResources

        <T extends CustomResource,​L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>> MixedOperation<T,​L,​Resource<T>> customResources​(Class<T> resourceType,
                                                                                                                                                                 Class<L> listClass)
        Typed API for managing CustomResources. You would need to provide POJOs for CustomResource into this and with it you would be able to instantiate a client specific to CustomResource.

        Note: your CustomResource POJO (T in this context) must implement Namespaced if it is a namespace-scoped resource.

        Type Parameters:
        T - T type represents CustomResource type. If it's a namespace-scoped resource, it must implement Namespaced
        L - L type represents CustomResourceList type
        Parameters:
        resourceType - Class for CustomResource
        listClass - Class for list object for CustomResource
        Returns:
        returns a MixedOperation object with which you can do basic CustomResource operations

      • customResources

        @Deprecated
<T extends io.fabric8.kubernetes.api.model.HasMetadata,​L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>> MixedOperation<T,​L,​Resource<T>> customResources​(CustomResourceDefinitionContext crdContext,
                                                                                                                                                                                              Class<T> resourceType,
                                                                                                                                                                                              Class<L> listClass)
        Deprecated.
        Since 5.x versions of client CustomResourceDefinitionContext is now configured via annotations inside POJOs, no need to provide it explicitly here.
        Typed API for managing CustomResources. You would need to provide POJOs for CustomResource into this and with it you would be able to instantiate a client specific to CustomResource.

        Note: your CustomResource POJO (T in this context) must implement io.fabric8.kubernetes.api.model.Namespaced if it is a Namespaced scoped resource.

        Type Parameters:
        T - T type represents CustomResource type. If it's Namespaced resource, it must implement io.fabric8.kubernetes.api.model.Namespaced
        L - L type represents CustomResourceList type
        Parameters:
        crdContext - CustomResourceDefinitionContext describes the core fields used to search for CustomResources
        resourceType - Class for CustomResource
        listClass - Class for list object for CustomResource
        Returns:
        returns a MixedOperation object with which you can do basic CustomResource operations

      • extensions

        ExtensionsAPIGroupDSL extensions()
        Extensions API entrypoint for APIGroup extensions/v1beta1
        Returns:
        ExtensionsAPIGroupDSL with which you can access entrypoints for extension objects

      • getVersion

        VersionInfo getVersion()
        Get Kubernetes API server version
        Returns:
        VersionInfo object containing versioning information

      • customResource

        RawCustomResourceOperationsImpl customResource​(CustomResourceDefinitionContext customResourceDefinition)
        Typeless API for interacting with CustomResources. You can do basic operations with CustomResources without having any model. You just need to pass an object providing basic information of CustomResource. CustomResource objects are parsed as HashMaps.
        Parameters:
        customResourceDefinition - CustomResourceDefinitionContext - information about CustomResource like versioning, namespaced or not and group etc
        Returns:
        a RawCustomResourceOperations object which offers several functions for creating, deleting, updating, watching CustomResources.

      • admissionRegistration

        AdmissionRegistrationAPIGroupDSL admissionRegistration()
        API entrypoint for kubernetes resources with APIGroup admissionregistration.k8s.io/v1beta1
        Returns:
        AdmissionRegistrationAPIGroupDSL which offers entrypoints to specific resources in this API group

      • apps

        AppsAPIGroupDSL apps()
        API entrypoint for kubernetes resources with APIGroup apps/v1
        Returns:
        AppsAPIGroupDSL which offers entrypoints to specific resources in this API group

      • autoscaling

        AutoscalingAPIGroupDSL autoscaling()
        API entrypoint for kubernetes resources with APIGroup autoscaling/v2beta1
        Returns:
        AutoScalingAPIGroupDSL which offers entrypoints to specific resources in this API group

      • network

        NetworkAPIGroupDSL network()
        API entrypoint for kubernetes resources with APIGroup networking/v1
        Returns:
        NetworkAPIGroupDSL which offers entrypoints to specific resources in this APIGroup

      • storage

        StorageAPIGroupDSL storage()
        API entrypoint for kubernetes resources with APIGroup storage/v1
        Returns:
        StorageAPIGroupDSL which offers entrypoints to specific resources in this APIGroup

      • batch

        BatchAPIGroupDSL batch()
        API entrypoint for kubernetes resources with APIGroup batch/v1beta1
        Returns:
        BatchAPIGroupDSL which offers entrypoint to specific resources in this APIGroup

      • top

        MetricAPIGroupDSL top()
        API entrypoint for kubernetes metrics
        Returns:
        MetricAPIGroupDSL which offers for fetching metrics

      • policy

        PolicyAPIGroupDSL policy()
        API entrypoint for kubernetes resources with APIGroup policy/v1beta1
        Returns:
        PolicyAPIGroupDSL which offers entrypoint to specific resources in this APIGroup

      • rbac

        RbacAPIGroupDSL rbac()
        API entrypoint for kubernetes resources with APIGroup rbac/v1
        Returns:
        RbacAPIGroupDSL which offers entrypoint to specific resources in this APIGroup

      • scheduling

        SchedulingAPIGroupDSL scheduling()
        API entrypoint for kubernetes resources with APIGroup scheduling/v1beta1
        Returns:
        SchedulingAPIGroupDSL which offers entrypoint to specific resources in this APIGroup

      • componentstatuses

        MixedOperation<io.fabric8.kubernetes.api.model.ComponentStatus,​io.fabric8.kubernetes.api.model.ComponentStatusList,​Resource<io.fabric8.kubernetes.api.model.ComponentStatus>> componentstatuses()
        API entrypoint for dealing with core/v1/ComponentStatus
        Returns:
        MixedOperation object with which you can do basic operations for ComponentStatus

      • resourceList

        NamespaceListVisitFromServerGetDeleteRecreateWaitApplicable<io.fabric8.kubernetes.api.model.HasMetadata> resourceList​(io.fabric8.kubernetes.api.model.KubernetesResourceList list)
        KubernetesResourceList operations
        Parameters:
        list - KubernetesResourceList object containing kubernetes resource items
        Returns:
        operations object for KubernetesResourceList

      • resourceList

        NamespaceListVisitFromServerGetDeleteRecreateWaitApplicable<io.fabric8.kubernetes.api.model.HasMetadata> resourceList​(io.fabric8.kubernetes.api.model.HasMetadata... items)
        KubernetesResourceList operations
        Parameters:
        items - array of HasMetadata values
        Returns:
        operations object for Kubernetes list

      • resource

        <T extends io.fabric8.kubernetes.api.model.HasMetadata> NamespaceVisitFromServerGetWatchDeleteRecreateWaitApplicable<T> resource​(T is)
        KubernetesResource operations. You can pass any Kubernetes resource as a HasMetadata object and do all operations
        Type Parameters:
        T - type of Kubernetes resource
        Parameters:
        is - Kubernetes resource object
        Returns:
        operations object for Kubernetes resource

      • resource

        NamespaceVisitFromServerGetWatchDeleteRecreateWaitApplicable<io.fabric8.kubernetes.api.model.HasMetadata> resource​(String s)
        KubernetesResource operations. You can pass any Kubernetes resource as string object and do all operations
        Parameters:
        s - Kubernetes resource object as string
        Returns:
        operations object for Kubernetes resource

      • bindings

        MixedOperation<io.fabric8.kubernetes.api.model.Binding,​io.fabric8.kubernetes.api.model.KubernetesResourceList<io.fabric8.kubernetes.api.model.Binding>,​Resource<io.fabric8.kubernetes.api.model.Binding>> bindings()
        Operations for Binding resource in APIgroup core/v1
        Returns:
        MixedOperation object for doing operations for Binding

      • endpoints

        MixedOperation<io.fabric8.kubernetes.api.model.Endpoints,​io.fabric8.kubernetes.api.model.EndpointsList,​Resource<io.fabric8.kubernetes.api.model.Endpoints>> endpoints()
        API entrypoint for Endpoints with APIGroup core/v1
        Returns:
        MixedOperation object for doing operations for Endpoints

      • namespaces

        NonNamespaceOperation<io.fabric8.kubernetes.api.model.Namespace,​io.fabric8.kubernetes.api.model.NamespaceList,​Resource<io.fabric8.kubernetes.api.model.Namespace>> namespaces()
        API entrypoint for namespace related operations in Kubernetes. Namespace (core/v1)
        Returns:
        NonNamespaceOperation object for Namespace related operations

      • nodes

        NonNamespaceOperation<io.fabric8.kubernetes.api.model.Node,​io.fabric8.kubernetes.api.model.NodeList,​Resource<io.fabric8.kubernetes.api.model.Node>> nodes()
        API entrypoint for node related operations in Kubernetes. Node (core/v1)
        Returns:
        NonNamespaceOperation object for Node related operations

      • persistentVolumes

        NonNamespaceOperation<io.fabric8.kubernetes.api.model.PersistentVolume,​io.fabric8.kubernetes.api.model.PersistentVolumeList,​Resource<io.fabric8.kubernetes.api.model.PersistentVolume>> persistentVolumes()
        API entrypoint for PersistentVolume related operations. PersistentVolume (core/v1)
        Returns:
        NonNamespaceOperation object for PersistentVolume related operations.

      • persistentVolumeClaims

        MixedOperation<io.fabric8.kubernetes.api.model.PersistentVolumeClaim,​io.fabric8.kubernetes.api.model.PersistentVolumeClaimList,​Resource<io.fabric8.kubernetes.api.model.PersistentVolumeClaim>> persistentVolumeClaims()
        API entrypoint for PersistentVolumeClaim related operations. PersistentVolumeClaim (core/v1)
        Returns:
        MixedOperation object for PersistentVolumeClaim related operations.

      • pods

        MixedOperation<io.fabric8.kubernetes.api.model.Pod,​io.fabric8.kubernetes.api.model.PodList,​PodResource<io.fabric8.kubernetes.api.model.Pod>> pods()
        API entrypoint for Pod related operations. Pod (core/v1)
        Returns:
        MixedOperation object for Pod related operations

      • replicationControllers

        MixedOperation<io.fabric8.kubernetes.api.model.ReplicationController,​io.fabric8.kubernetes.api.model.ReplicationControllerList,​RollableScalableResource<io.fabric8.kubernetes.api.model.ReplicationController>> replicationControllers()
        API entrypoint for ReplicationController related operations. ReplicationController (core/v1)
        Returns:
        MixedOperation object for ReplicationController related operations.

      • resourceQuotas

        MixedOperation<io.fabric8.kubernetes.api.model.ResourceQuota,​io.fabric8.kubernetes.api.model.ResourceQuotaList,​Resource<io.fabric8.kubernetes.api.model.ResourceQuota>> resourceQuotas()
        API entrypoint for ResourceQuota related operations. ResourceQuota (core/v1)
        Returns:
        MixedOperation object for ResourceQuota related operations.

      • secrets

        MixedOperation<io.fabric8.kubernetes.api.model.Secret,​io.fabric8.kubernetes.api.model.SecretList,​Resource<io.fabric8.kubernetes.api.model.Secret>> secrets()
        API entrypoint for Secret related operations. Secret (core/v1)
        Returns:
        MixedOperation object for Secret related operations.

      • services

        MixedOperation<io.fabric8.kubernetes.api.model.Service,​io.fabric8.kubernetes.api.model.ServiceList,​ServiceResource<io.fabric8.kubernetes.api.model.Service>> services()
        API entrypoint for Service related operations. Service (core/v1)
        Returns:
        MixedOperation object for Service related operations.

      • serviceAccounts

        MixedOperation<io.fabric8.kubernetes.api.model.ServiceAccount,​io.fabric8.kubernetes.api.model.ServiceAccountList,​Resource<io.fabric8.kubernetes.api.model.ServiceAccount>> serviceAccounts()
        API entrypoint for ServiceAccount related operations. ServiceAccount (core/v1)
        Returns:
        MixedOperation object for ServiceAccount related operations.

      • apiServices

        MixedOperation<io.fabric8.kubernetes.api.model.APIService,​io.fabric8.kubernetes.api.model.APIServiceList,​Resource<io.fabric8.kubernetes.api.model.APIService>> apiServices()
        API entrypoint for APIService related operations. APIService (apiregistration.k8s.io/v1)
        Returns:
        MixedOperation object for APIService related operations

      • configMaps

        MixedOperation<io.fabric8.kubernetes.api.model.ConfigMap,​io.fabric8.kubernetes.api.model.ConfigMapList,​Resource<io.fabric8.kubernetes.api.model.ConfigMap>> configMaps()
        API entrypoint for ConfigMap related operations. ConfigMap (core/v1)
        Returns:
        MixedOperation object for ConfigMap related operations.

      • limitRanges

        MixedOperation<io.fabric8.kubernetes.api.model.LimitRange,​io.fabric8.kubernetes.api.model.LimitRangeList,​Resource<io.fabric8.kubernetes.api.model.LimitRange>> limitRanges()
        API entrypoint for LimitRange related operations. LimitRange (core/v1)
        Returns:
        MixedOperation object for LimitRange related operations.

      • authorization

        AuthorizationAPIGroupDSL authorization()
        Authorization operations. (authorization.k8s.io/v1 and authorization.k8s.io/v1beta1)
        Returns:
        AuthorizationAPIGroupDSL object for dealing with Authorization objects

      • tokenReviews

        Createable<io.fabric8.kubernetes.api.model.authentication.TokenReview> tokenReviews()
        API for creating authentication.k8s.io/v1 TokenReviews
        Returns:
        CreateOnlyResourceOperations instance for creating TokenReview object

      • informers

        SharedInformerFactory informers()
        Get an instance of Kubernetes Client informer factory. It allows you to construct and cache informers for API types. With it you can subscribe to all the events related to your Kubernetes type. It's like watch but a bit organized.
        Returns:
        SharedInformerFactory object

      • informers

        SharedInformerFactory informers​(ExecutorService executorService)
        Get an instance of Kubernetes Client informer factory. It allows you to construct and cache informers for API types. With it you can subscribe to all the events related to your Kubernetes type. It's like watch but a bit organized.
        Parameters:
        executorService - thread pool for informer factory
        Returns:
        SharedInformerFactory object

      • leaderElector

        <C extends Namespaceable<C> & KubernetesClient> LeaderElectorBuilder<C> leaderElector()
        API entrypoint for LeaderElector implementation for leader election.
        Type Parameters:
        C - type parameter for the Namespaceable KubernetesClient
        Returns:
        LeaderElectorBuilder to build LeaderElector instances

      • leases

        MixedOperation<io.fabric8.kubernetes.api.model.coordination.v1.Lease,​io.fabric8.kubernetes.api.model.coordination.v1.LeaseList,​Resource<io.fabric8.kubernetes.api.model.coordination.v1.Lease>> leases()
        API entrypoint for Lease related operations. Lease (coordination.k8s.io/v1)
        Returns:
        MixedOperation object for Lease related operations.

      • v1

        V1APIGroupDSL v1()
        API entrypoint for Core Kubernetes Resources (core/v1). Right now other core resources have their own DSL entrypoints. But in future, all core/v1 resources would be added here.
        Returns:
        V1APIGroupDSL DSL object for core v1 resources

      • run

        RunOperations run()
        Run a Pod (core/v1)
        Returns:
        returns RunOperations that allows you to run a pod based on few parameters(e.g. name, image etc)

      • runtimeClasses

        NonNamespaceOperation<io.fabric8.kubernetes.api.model.node.v1beta1.RuntimeClass,​io.fabric8.kubernetes.api.model.node.v1beta1.RuntimeClassList,​Resource<io.fabric8.kubernetes.api.model.node.v1beta1.RuntimeClass>> runtimeClasses()
        API entrypoint for RuntimeClass (node.k8s.io/v1beta1)
        Returns:
        NonNamespaceOperation for RuntimeClass