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

      • resources

        default <T extends io.fabric8.kubernetes.api.model.HasMetadata> MixedOperation<T,​io.fabric8.kubernetes.api.model.KubernetesResourceList<T>,​Resource<T>> resources​(Class<T> resourceType)
        Typed API for managing resources. Any properly annotated POJO can be utilized as a resource.

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

        Type Parameters:
        T - T type represents resource type. If it's a namespaced resource, it must implement Namespaced
        Parameters:
        resourceType - Class for resource
        Returns:
        returns a MixedOperation object with which you can do basic resource operations. If the class is a known type the dsl operation logic will be used.

      • genericKubernetesResources

        MixedOperation<io.fabric8.kubernetes.api.model.GenericKubernetesResource,​io.fabric8.kubernetes.api.model.GenericKubernetesResourceList,​Resource<io.fabric8.kubernetes.api.model.GenericKubernetesResource>> genericKubernetesResources​(ResourceDefinitionContext context)
        Semi-Typed API for managing GenericKubernetesResources which can represent any resource.
        Parameters:
        context - ResourceDefinitionContext describes the core metadata
        Returns:
        returns a MixedOperation object with which you can do basic operations
        See Also:
        if you don't want to supply a complete

      • genericKubernetesResources

        MixedOperation<io.fabric8.kubernetes.api.model.GenericKubernetesResource,​io.fabric8.kubernetes.api.model.GenericKubernetesResourceList,​Resource<io.fabric8.kubernetes.api.model.GenericKubernetesResource>> genericKubernetesResources​(String apiVersion,
                                                                                                                                                                                                                                                   String kind)
        Semi-typed API for managing resources. Will perform a look-up if needed for additional metadata about the resource.
        Parameters:
        apiVersion - the api/version
        kind - the resource kind
        Returns:
        returns a MixedOperation object with which you can do basic resource operations.

      • events

        EventingAPIGroupDSL events()
        Event API entrypoint for APIGroup events.k8s.io Note: This should not be confused with v1.Event
        Returns:
        EventingAPIGroupDSL with which you can access Events API resources objects.

      • extensions

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

      • getKubernetesVersion

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

      • 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

        NonNamespaceOperation<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

      • resourceList

        NamespaceListVisitFromServerGetDeleteRecreateWaitApplicable<io.fabric8.kubernetes.api.model.HasMetadata> resourceList​(Collection<? extends io.fabric8.kubernetes.api.model.HasMetadata> items)
        KubernetesResourceList operations
        Parameters:
        items - a collection containing HasMetadata values
        Returns:
        operations object for Kubernetes list

      • resource

        <T extends io.fabric8.kubernetes.api.model.HasMetadata> NamespaceableResource<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

        NamespaceableResource<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 - a Kubernetes resource object as string
        Returns:
        operations object for Kubernetes resource

      • resource

        NamespaceableResource<io.fabric8.kubernetes.api.model.HasMetadata> resource​(InputStream is)
        KubernetesResource operations. You can pass any Kubernetes resource as an InputStream object and perform all operations
        Parameters:
        is - the InputStream containing a serialized Kubernetes resource.
        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> 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,​ServiceAccountResource> serviceAccounts()
        API entrypoint for ServiceAccount related operations. ServiceAccount (core/v1)
        Returns:
        MixedOperation object for ServiceAccount related operations.

      • apiServices

        NonNamespaceOperation<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

        InOutCreateable<io.fabric8.kubernetes.api.model.authentication.TokenReview,​io.fabric8.kubernetes.api.model.authentication.TokenReview> tokenReviews()
        API for creating authentication.k8s.io/v1 TokenReviews
        Returns:
        InOutCreateable 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.

        Each call to this method returns a new factory.

        Returns:
        SharedInformerFactory object

      • leaderElector

        LeaderElectorBuilder leaderElector()
        API entrypoint for LeaderElector implementation for leader election.
        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

      • visitResources

        void visitResources​(ApiVisitor visitor)
        Visit all resources with the given ApiVisitor.
        Parameters:
        visitor -