Package io.fabric8.openshift.client

Interface OpenShiftClient

    • Method Detail

      • getOpenshiftUrl

        URL getOpenshiftUrl()
        Get Url of the cluster
        Returns:
        URL of OpenShift Cluster

      • getOpenShiftV3Version

        VersionInfo getOpenShiftV3Version()
        Get OpenShift version information from version/openshift
        Returns:
        VersionInfo object containing versioning information

      • getOpenShiftV4Version

        String getOpenShiftV4Version()
        Get OpenShift server version
        for more information use resources(ClusterVersion.class).list()
        Returns:
        version String

      • apiRequestCounts

        NonNamespaceOperation<io.fabric8.openshift.api.model.miscellaneous.apiserver.v1.APIRequestCount,​io.fabric8.openshift.api.model.miscellaneous.apiserver.v1.APIRequestCountList,​Resource<io.fabric8.openshift.api.model.miscellaneous.apiserver.v1.APIRequestCount>> apiRequestCounts()
        API entrypoint for APIRequestCount (apiserver.openshift.io/v1)
        Returns:
        NonNamespaceOperation for APIRequestCoutn

      • bareMetalHosts

        MixedOperation<io.fabric8.openshift.api.model.miscellaneous.metal3.v1alpha1.BareMetalHost,​io.fabric8.openshift.api.model.miscellaneous.metal3.v1alpha1.BareMetalHostList,​Resource<io.fabric8.openshift.api.model.miscellaneous.metal3.v1alpha1.BareMetalHost>> bareMetalHosts()
        API entrypoint for BareMetalHost(metal3.io/v1alpha1)
        Returns:
        MixedOperation for BareMetalHost

      • builds

        MixedOperation<io.fabric8.openshift.api.model.Build,​io.fabric8.openshift.api.model.BuildList,​BuildResource> builds()
        API entrypoint for handling Build(build.openshift.io/v1)
        Returns:
        MixedOperation instance for Build object

      • buildConfigs

        MixedOperation<io.fabric8.openshift.api.model.BuildConfig,​io.fabric8.openshift.api.model.BuildConfigList,​BuildConfigResource<io.fabric8.openshift.api.model.BuildConfig,​Void,​io.fabric8.openshift.api.model.Build>> buildConfigs()
        API entrypoint for handling BuildConfig(build.openshift.io/v1)
        Returns:
        MixedOperation instance for BuildConfig object

      • credentialsRequests

        MixedOperation<io.fabric8.openshift.api.model.miscellaneous.cloudcredential.v1.CredentialsRequest,​io.fabric8.openshift.api.model.miscellaneous.cloudcredential.v1.CredentialsRequestList,​Resource<io.fabric8.openshift.api.model.miscellaneous.cloudcredential.v1.CredentialsRequest>> credentialsRequests()
        API entrypoint for CredentialsRequest (cloudcredential.openshift.io/v1)
        Returns:
        MixedOperation for CredentialsRequest

      • deploymentConfigs

        MixedOperation<io.fabric8.openshift.api.model.DeploymentConfig,​io.fabric8.openshift.api.model.DeploymentConfigList,​DeployableScalableResource<io.fabric8.openshift.api.model.DeploymentConfig>> deploymentConfigs()
        API entrypoint for handling DeploymentConfig(apps.openshift.io/v1)
        Returns:
        MixedOperation instance for DeploymentConfig object

      • groups

        NonNamespaceOperation<io.fabric8.openshift.api.model.Group,​io.fabric8.openshift.api.model.GroupList,​Resource<io.fabric8.openshift.api.model.Group>> groups()
        API entrypoint for handling Group(user.openshift.io/v1)
        Returns:
        NonNamespaceOperation instance for Group object

      • helmChartRepositories

        NonNamespaceOperation<io.fabric8.openshift.api.model.miscellaneous.helm.v1beta1.HelmChartRepository,​io.fabric8.openshift.api.model.miscellaneous.helm.v1beta1.HelmChartRepositoryList,​Resource<io.fabric8.openshift.api.model.miscellaneous.helm.v1beta1.HelmChartRepository>> helmChartRepositories()
        API entrypoint for handling HelmChartRepository(helm.openshift.io/v1beta1)
        Returns:
        NonNamespaceOperation for HelmChartRepository

      • images

        NonNamespaceOperation<io.fabric8.openshift.api.model.Image,​io.fabric8.openshift.api.model.ImageList,​Resource<io.fabric8.openshift.api.model.Image>> images()
        API entrypoint for accessing Image(image.openshift.io/v1)
        Returns:
        Non Namespace Operation object for Image

      • imageTags

        MixedOperation<io.fabric8.openshift.api.model.ImageTag,​io.fabric8.openshift.api.model.ImageTagList,​Resource<io.fabric8.openshift.api.model.ImageTag>> imageTags()
        API entrypoint for accessing ImageTag(image.openshift.io/v1)
        Returns:
        MixedOperation object for ImageTag

      • imageStreams

        MixedOperation<io.fabric8.openshift.api.model.ImageStream,​io.fabric8.openshift.api.model.ImageStreamList,​Resource<io.fabric8.openshift.api.model.ImageStream>> imageStreams()
        API entrypoint for accessing ImageStream(image.openshift.io/v1)
        Returns:
        MixedOperation object for ImageStream

      • imageStreamTags

        MixedOperation<io.fabric8.openshift.api.model.ImageStreamTag,​io.fabric8.openshift.api.model.ImageStreamTagList,​Resource<io.fabric8.openshift.api.model.ImageStreamTag>> imageStreamTags()
        API entrypoint for accessing ImageStreamTag(image.openshift.io/v1)
        Returns:
        MixedOperation object for ImageStreamTag

      • imageStreamImports

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.ImageStreamImport,​io.fabric8.openshift.api.model.ImageStreamImport> imageStreamImports()
        API entrypoint for accessing ImageStreamImport(image.openshift.io/v1)
        Returns:
        NamespacedInOutCreateable for ImageStreamImport

      • imageStreamMappings

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.ImageStreamMapping,​io.fabric8.openshift.api.model.ImageStreamMapping> imageStreamMappings()
        API entrypoint for accessing ImageStreamMapping(image.openshift.io/v1)
        Returns:
        NamespacedInOutCreateable for ImageStreamMapping

      • imageStreamImages

        Namespaceable<Nameable<? extends Gettable<io.fabric8.openshift.api.model.ImageStreamImage>>> imageStreamImages()
        API entrypoint for accessing ImageStreamImage(image.openshift.io/v1)
        Returns:
        Namespaceable for ImageStreamImage operations

      • imageRegistryOperatorConfigs

        NonNamespaceOperation<io.fabric8.openshift.api.model.operator.imageregistry.v1.Config,​io.fabric8.openshift.api.model.operator.imageregistry.v1.ConfigList,​Resource<io.fabric8.openshift.api.model.operator.imageregistry.v1.Config>> imageRegistryOperatorConfigs()
        API entrypoint for Config(imageregistry.operator.openshift.io/v1)
        Returns:
        NonNamespaceOperation for Config

      • metal3Remediations

        MixedOperation<io.fabric8.openshift.api.model.miscellaneous.metal3.v1beta1.Metal3Remediation,​io.fabric8.openshift.api.model.miscellaneous.metal3.v1beta1.Metal3RemediationList,​Resource<io.fabric8.openshift.api.model.miscellaneous.metal3.v1beta1.Metal3Remediation>> metal3Remediations()
        API entrypoint for Metal3Remediation (infrastructure.cluster.x-k8s.io/v1beta1)
        Returns:
        MixedOperation for Metal3Remediation

      • metal3RemediationTemplates

        MixedOperation<io.fabric8.openshift.api.model.miscellaneous.metal3.v1beta1.Metal3RemediationTemplate,​io.fabric8.openshift.api.model.miscellaneous.metal3.v1beta1.Metal3RemediationTemplateList,​Resource<io.fabric8.openshift.api.model.miscellaneous.metal3.v1beta1.Metal3RemediationTemplate>> metal3RemediationTemplates()
        API entrypoint for Metal3RemediationTemplate (infrastructure.cluster.x-k8s.io/v1beta1)
        Returns:
        MixedOperation for Metal3RemediationTemplate

      • networkAttachmentDefinitions

        MixedOperation<io.fabric8.openshift.api.model.miscellaneous.cncf.cni.v1.NetworkAttachmentDefinition,​io.fabric8.openshift.api.model.miscellaneous.cncf.cni.v1.NetworkAttachmentDefinitionList,​Resource<io.fabric8.openshift.api.model.miscellaneous.cncf.cni.v1.NetworkAttachmentDefinition>> networkAttachmentDefinitions()
        API entrypoint for accessing NetworkAttachmentDefinition(k8s.cni.cncf.io/v1)
        Returns:
        MixedOperation for NetworkAttachmentDefinition

      • oAuthAccessTokens

        NonNamespaceOperation<io.fabric8.openshift.api.model.OAuthAccessToken,​io.fabric8.openshift.api.model.OAuthAccessTokenList,​Resource<io.fabric8.openshift.api.model.OAuthAccessToken>> oAuthAccessTokens()
        API entrypoint for accessing OAuthAccessToken(oauth.openshift.io/v1)
        Returns:
        NonNamespaceOperation object for OAuthAccessToken

      • oAuthAuthorizeTokens

        NonNamespaceOperation<io.fabric8.openshift.api.model.OAuthAuthorizeToken,​io.fabric8.openshift.api.model.OAuthAuthorizeTokenList,​Resource<io.fabric8.openshift.api.model.OAuthAuthorizeToken>> oAuthAuthorizeTokens()
        API entrypoint for accessing OAuthAuthorizeToken(oauth.openshift.io/v1)
        Returns:
        NonNamespaceOperation object for OAuthAuthorizeToken

      • oAuthClients

        NonNamespaceOperation<io.fabric8.openshift.api.model.OAuthClient,​io.fabric8.openshift.api.model.OAuthClientList,​Resource<io.fabric8.openshift.api.model.OAuthClient>> oAuthClients()
        API entrypoint for accessing OAuthClient(oauth.openshift.io/v1)
        Returns:
        NonNamespaceOperation object for OAuthClient

      • oAuthClientAuthorizations

        NonNamespaceOperation<io.fabric8.openshift.api.model.OAuthClientAuthorization,​io.fabric8.openshift.api.model.OAuthClientAuthorizationList,​Resource<io.fabric8.openshift.api.model.OAuthClientAuthorization>> oAuthClientAuthorizations()
        API entrypoint for accessing OAuthClientAuthorization(oauth.openshift.io/v1)
        Returns:
        NonNamespaceOperation for OAuthClientAuthorization

      • operatorPKIs

        MixedOperation<io.fabric8.openshift.api.model.operator.network.v1.OperatorPKI,​io.fabric8.openshift.api.model.operator.network.v1.OperatorPKIList,​Resource<io.fabric8.openshift.api.model.operator.network.v1.OperatorPKI>> operatorPKIs()
        API entrypoint for OperatorPKI(network.operator.openshift.io/v1)
        Returns:
        MixedOperation for OperatorPKI

      • egressRouters

        MixedOperation<io.fabric8.openshift.api.model.operator.network.v1.EgressRouter,​io.fabric8.openshift.api.model.operator.network.v1.EgressRouterList,​Resource<io.fabric8.openshift.api.model.operator.network.v1.EgressRouter>> egressRouters()
        API entrypoint for EgressRouter (network.operator.openshift.io/v1)
        Returns:
        MixedOperation for EgressRouter

      • podSecurityPolicyReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.PodSecurityPolicyReview,​io.fabric8.openshift.api.model.PodSecurityPolicyReview> podSecurityPolicyReviews()
        API entrypoint for accessing PodSecurityPolicyReview (security.openshift.io/v1)
        Returns:
        InOutCreateable object for PodSecurityPolicyReview

      • podSecurityPolicySelfSubjectReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.PodSecurityPolicySelfSubjectReview,​io.fabric8.openshift.api.model.PodSecurityPolicySelfSubjectReview> podSecurityPolicySelfSubjectReviews()
        API entrypoint for accessing PodSecurityPolicySelfSubjectReview (security.openshift.io/v1)
        Returns:
        InOutCreateable object for PodSecurityPolicySelfSubjectReview

      • podSecurityPolicySubjectReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.PodSecurityPolicySubjectReview,​io.fabric8.openshift.api.model.PodSecurityPolicySubjectReview> podSecurityPolicySubjectReviews()
        API entrypoint for accessing PodSecurityPolicySubjectReview (security.openshift.io/v1)
        Returns:
        InOutCreateable object for PodSecurityPolicySubjectReview

      • projects

        ProjectOperation projects()
        API entrypoint for accessing Project operations(project.openshift.io/v1)
        Returns:
        ProjectOperation for Project specific operations

      • projectHelmChartRepositories

        MixedOperation<io.fabric8.openshift.api.model.miscellaneous.helm.v1beta1.ProjectHelmChartRepository,​io.fabric8.openshift.api.model.miscellaneous.helm.v1beta1.ProjectHelmChartRepositoryList,​Resource<io.fabric8.openshift.api.model.miscellaneous.helm.v1beta1.ProjectHelmChartRepository>> projectHelmChartRepositories()
        API entrypoint for handling ProjectHelmChartRepository (helm.openshift.io/v1beta1)
        Returns:
        NonNamespaceOperation for ProjectHelmChartRepository

      • roles

        MixedOperation<io.fabric8.openshift.api.model.Role,​io.fabric8.openshift.api.model.RoleList,​Resource<io.fabric8.openshift.api.model.Role>> roles()
        API entrypoint for accessing Role(authorization.openshift.io/v1)
        Returns:
        MixedOperation object for Role

      • roleBindings

        MixedOperation<io.fabric8.openshift.api.model.RoleBinding,​io.fabric8.openshift.api.model.RoleBindingList,​Resource<io.fabric8.openshift.api.model.RoleBinding>> roleBindings()
        API entrypoint for accessing RoleBinding(authorization.openshift.io/v1)
        Returns:
        MixedOperation object for RoleBinding

      • routes

        MixedOperation<io.fabric8.openshift.api.model.Route,​io.fabric8.openshift.api.model.RouteList,​Resource<io.fabric8.openshift.api.model.Route>> routes()
        API entrypoint for accessing Route(route.openshift.io/v1)
        Returns:
        MixedOperation object for Route

      • templateInstances

        MixedOperation<io.fabric8.openshift.api.model.TemplateInstance,​io.fabric8.openshift.api.model.TemplateInstanceList,​Resource<io.fabric8.openshift.api.model.TemplateInstance>> templateInstances()
        API entrypoint for TemplateInstance(template.openshift.io/v1)
        Returns:
        MixedOperation for TemplateInstance

      • brokerTemplateInstances

        NonNamespaceOperation<io.fabric8.openshift.api.model.BrokerTemplateInstance,​io.fabric8.openshift.api.model.BrokerTemplateInstanceList,​Resource<io.fabric8.openshift.api.model.BrokerTemplateInstance>> brokerTemplateInstances()
        API entrypoint for BrokerTemplateInstance(template.openshift.io/v1)
        Returns:
        NonNamespaceOperation for BrokerTemplateInstance

      • users

        NonNamespaceOperation<io.fabric8.openshift.api.model.User,​io.fabric8.openshift.api.model.UserList,​Resource<io.fabric8.openshift.api.model.User>> users()
        API entrypoint for accessing User(user.openshift.io/v1)
        Returns:
        NonNamespaceOperation object for User

      • rangeAllocations

        NonNamespaceOperation<io.fabric8.openshift.api.model.RangeAllocation,​io.fabric8.openshift.api.model.RangeAllocationList,​Resource<io.fabric8.openshift.api.model.RangeAllocation>> rangeAllocations()
        API entrypoint for accessing RangeAllocation(security.openshift.io/v1)
        Returns:
        NonNamespaceOperation object for RangeAllocation

      • securityContextConstraints

        NonNamespaceOperation<io.fabric8.openshift.api.model.SecurityContextConstraints,​io.fabric8.openshift.api.model.SecurityContextConstraintsList,​Resource<io.fabric8.openshift.api.model.SecurityContextConstraints>> securityContextConstraints()
        API entrypoint for accessing SecurityContextConstraints(security.openshift.io/v1)
        Returns:
        NonNamespaceOperation object for SecurityContextConstraints

      • subjectAccessReviews

        InOutCreateable<io.fabric8.openshift.api.model.SubjectAccessReview,​io.fabric8.openshift.api.model.SubjectAccessReviewResponse> subjectAccessReviews()
        API entrypoint for SubjectAccessReview (authorization.openshift.io/v1) This only supports create operation. SubjectAccessReviewResponse from server is returned as output.
        Returns:
        InOutCreateable for SubjectAccessReview

      • resourceAccessReviews

        InOutCreateable<io.fabric8.openshift.api.model.ResourceAccessReview,​io.fabric8.openshift.api.model.ResourceAccessReviewResponse> resourceAccessReviews()
        API entrypoint for ResourceAccessReview (authorization.openshift.io/v1) This only supports create operation. ResourceAccessReviewResponse from server is returned as output
        Returns:
        InOutCreateable for ResourceAccessReview

      • localSubjectAccessReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.LocalSubjectAccessReview,​io.fabric8.openshift.api.model.SubjectAccessReviewResponse> localSubjectAccessReviews()
        API entrypoint for LocalSubjectAccessReview (authorization.openshift.io/v1) This only supports create operation. SubjectAccessReviewResponse from server is returned as output
        Returns:
        NamespacedInOutCreateable for LocalSubjectAccessReview

      • localResourceAccessReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.LocalResourceAccessReview,​io.fabric8.openshift.api.model.ResourceAccessReviewResponse> localResourceAccessReviews()
        API entrypoint for LocalResourceAccessReview (authorization.openshift.io/v1) This only supports create operation. ResourceAccessReviewResponse from server is returned as output
        Returns:
        NamespacedInOutCreateable for LocalResourceAccessReview

      • selfSubjectRulesReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.SelfSubjectRulesReview,​io.fabric8.openshift.api.model.SelfSubjectRulesReview> selfSubjectRulesReviews()
        API entrypoint for SelfSubjectRulesReview (authorization.openshift.io/v1) This only supports create operation. SelfSubjectRulesReview from server is returned as output
        Returns:
        NamespacedInOutCreateable for SelfSubjectRulesReview

      • subjectRulesReviews

        NamespacedInOutCreateable<io.fabric8.openshift.api.model.SubjectRulesReview,​io.fabric8.openshift.api.model.SubjectRulesReview> subjectRulesReviews()
        API entrypoint for SubjectRulesReview (authorization.openshift.io/v1) This only supports create operation. SubjectRulesReview from server is returned as output
        Returns:
        NamespacedInOutCreateable for SubjectRulesReview

      • clusterRoles

        NonNamespaceOperation<io.fabric8.openshift.api.model.ClusterRole,​io.fabric8.openshift.api.model.ClusterRoleList,​Resource<io.fabric8.openshift.api.model.ClusterRole>> clusterRoles()
        API entrypoint for ClusterRole (authorization.openshift.io/v1)
        Returns:
        NonNamespaceOperation for ClusterRole

      • clusterRoleBindings

        MixedOperation<io.fabric8.openshift.api.model.ClusterRoleBinding,​io.fabric8.openshift.api.model.ClusterRoleBindingList,​Resource<io.fabric8.openshift.api.model.ClusterRoleBinding>> clusterRoleBindings()
        API entrypoint for accessing ClusterRoleBinding(authorization.openshift.io/v1)
        Returns:
        MixedOperation object for ClusterRoleBinding

      • roleBindingRestrictions

        MixedOperation<io.fabric8.openshift.api.model.RoleBindingRestriction,​io.fabric8.openshift.api.model.RoleBindingRestrictionList,​Resource<io.fabric8.openshift.api.model.RoleBindingRestriction>> roleBindingRestrictions()
        API entrypoint for RoleBindingRestriction (authorization.openshift.io/v1)
        Returns:
        MixedOperation for RoleBindingRestriction

      • currentUser

        io.fabric8.openshift.api.model.User currentUser()
        Returns the current logged in user details similar to the `oc whoami` command.
        Returns:
        User as currently logged in user

      • identities

        NonNamespaceOperation<io.fabric8.openshift.api.model.Identity,​io.fabric8.openshift.api.model.IdentityList,​Resource<io.fabric8.openshift.api.model.Identity>> identities()
        API entrypoint for Identity(user.openshift.io/v1)
        Returns:
        NonNamespaceOperation for Identity

      • userIdentityMappings

        InOutCreateable<io.fabric8.openshift.api.model.UserIdentityMapping,​io.fabric8.openshift.api.model.UserIdentityMapping> userIdentityMappings()
        API entrypoint for UserIdentityMapping(user.openshift.io/v1) Note: This only works with create operation
        Returns:
        UserIdentityMapping for UserIdentityMapping

      • userOAuthAccessTokens

        NonNamespaceOperation<io.fabric8.openshift.api.model.UserOAuthAccessToken,​io.fabric8.openshift.api.model.UserOAuthAccessTokenList,​Resource<io.fabric8.openshift.api.model.UserOAuthAccessToken>> userOAuthAccessTokens()
        API entrypoint for UserOAuthAccessToken(oauth.openshift.io/v1)

        Note: Only GET and DELETE operations are supported by APIServer for this resource.

        Returns:
        NonNamespaceOperation for UserOAuthAccessToken

      • supportsOpenShiftAPIGroup

        boolean supportsOpenShiftAPIGroup​(String apiGroup)
        Returns true if this cluster is a legacy openshift cluster or supports the given OpenShift API Group defined in OpenShiftAPIGroups
        Parameters:
        apiGroup - API group as string
        Returns:
        boolean value indicating cluster is legacy or supports APIGroups