Package io.fabric8.openshift.client

Interface OpenShiftClient

All Superinterfaces:

AutoCloseable, Client, Closeable, ConfigAware, KubernetesClient

All Known Subinterfaces:

NamespacedOpenShiftClient

All Known Implementing Classes:

DefaultOpenShiftClient, ManagedOpenShiftClient

public interface OpenShiftClient
extends KubernetesClient

Method Summary

Modifier and Type	Method	Description
AppsAPIGroupDSL	apps()
AutoscalingAPIGroupDSL	autoscaling()
BatchAPIGroupDSL	batch()
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)
MixedOperation<io.fabric8.openshift.api.model.Build,io.fabric8.openshift.api.model.BuildList,BuildResource<io.fabric8.openshift.api.model.Build,LogWatch>>	builds()	API entrypoint for handling Build(build.openshift.io/v1)
NonNamespaceOperation<io.fabric8.openshift.api.model.ClusterNetwork,io.fabric8.openshift.api.model.ClusterNetworkList,Resource<io.fabric8.openshift.api.model.ClusterNetwork>>	clusterNetworks()	API entrypoint for handling ClusterNetwork(network.openshift.io/v1)
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)
OpenShiftConfigAPIGroupDSL	config()	API entrypoint for accessing OpenShift config APIGroup resources(config.openshift.io/v1)
OpenShiftConsoleAPIGroupDSL	console()	API entrypoint for accessing OpenShift console APIGroup resources(console.openshift.io/v1)
io.fabric8.openshift.api.model.User	currentUser()	Returns the current logged in user details similar to the `oc whoami` command.
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)
MixedOperation<io.fabric8.openshift.api.model.EgressNetworkPolicy,io.fabric8.openshift.api.model.EgressNetworkPolicyList,Resource<io.fabric8.openshift.api.model.EgressNetworkPolicy>>	egressNetworkPolicies()	API entrypoint for handling EgressNetworkPolicy(network.openshift.io/v1)
ExtensionsAPIGroupDSL	extensions()
URL	getOpenshiftUrl()	Get Url of the cluster
VersionInfo	getVersion()
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)
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)
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)
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)
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)
OpenShiftLocalSubjectAccessReviewOperationsImpl	localSubjectAccessReviews()
OpenShiftMonitoringAPIGroupDSL	monitoring()	API entrypoint for accessing OpenShift operator APIGroup resources(monitoring.coreos.com/v1)
NonNamespaceOperation<io.fabric8.openshift.api.model.NetNamespace,io.fabric8.openshift.api.model.NetNamespaceList,Resource<io.fabric8.openshift.api.model.NetNamespace>>	netNamespaces()	API entrypoint for handling NetNamespace(network.openshift.io/v1)
NetworkAPIGroupDSL	network()
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)
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)
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)
OpenShiftOperatorAPIGroupDSL	operator()	API entrypoint for accessing OpenShift operator APIGroup resources(operator.openshift.io/v1 and operator.openshift.io/v1alpha1)
OpenShiftOperatorHubAPIGroupDSL	operatorHub()	API entrypoint for accessing OpenShift operator hub APIGroup resources(operator.coreos.com/v1alpha1)
ProjectRequestOperation	projectrequests()	API entrypoint for accessing ProjectRequest operations(project.openshift.io/v1)
ProjectOperation	projects()	API entrypoint for accessing Project operations(project.openshift.io/v1)
OpenShiftQuotaAPIGroupDSL	quotas()	API entrypoint for accessing OpenShift Quota APIGroup resources(quota.openshift.io/v1)
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)
RbacAPIGroupDSL	rbac()
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)
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)
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)
SchedulingAPIGroupDSL	scheduling()
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)
StorageAPIGroupDSL	storage()
InOutCreateable<io.fabric8.openshift.api.model.SubjectAccessReview,io.fabric8.openshift.api.model.SubjectAccessReviewResponse>	subjectAccessReviews()
boolean	supportsOpenShiftAPIGroup(String apiGroup)	Returns true if this cluster is a legacy openshift cluster or supports the given OpenShift API Group defined in OpenShiftAPIGroups
ParameterMixedOperation<io.fabric8.openshift.api.model.Template,io.fabric8.openshift.api.model.TemplateList,TemplateResource<io.fabric8.openshift.api.model.Template,io.fabric8.kubernetes.api.model.KubernetesList>>	templates()	API entrypoint for accessing Template(template.openshift.io/v1)
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)
FunctionCallable<NamespacedOpenShiftClient>	withRequestConfig(RequestConfig requestConfig)	Configure Request Config

Methods inherited from interface io.fabric8.kubernetes.client.Client

adapt, close, getApiVersion, getMasterUrl, getNamespace, isAdaptable, rootPaths, supportsApiPath

Methods inherited from interface io.fabric8.kubernetes.client.ConfigAware

getConfiguration

Methods inherited from interface io.fabric8.kubernetes.client.KubernetesClient

admissionRegistration, apiextensions, apiServices, authorization, bindings, certificates, certificateSigningRequests, componentstatuses, configMaps, customResource, customResources, customResources, customResources, discovery, endpoints, informers, informers, leaderElector, leases, limitRanges, lists, load, namespaces, nodes, persistentVolumeClaims, persistentVolumes, pods, policy, replicationControllers, resource, resource, resourceList, resourceList, resourceList, resourceList, resourceQuotas, run, runtimeClasses, secrets, serviceAccounts, services, tokenReviews, top, v1

Method Detail

getOpenshiftUrl

URL getOpenshiftUrl()

Get Url of the cluster

Returns:

URL of OpenShift Cluster

config

OpenShiftConfigAPIGroupDSL config()

API entrypoint for accessing OpenShift config APIGroup resources(config.openshift.io/v1)

Returns:

OpenShiftConfigAPIGroupDSL which contains respective resources in this API group

console

OpenShiftConsoleAPIGroupDSL console()

API entrypoint for accessing OpenShift console APIGroup resources(console.openshift.io/v1)

Returns:

OpenShiftConsoleAPIGroupDSL which contains respective resources in this API group

operator

OpenShiftOperatorAPIGroupDSL operator()

API entrypoint for accessing OpenShift operator APIGroup resources(operator.openshift.io/v1 and operator.openshift.io/v1alpha1)

Returns:

OpenShiftOperatorAPIGroupDSL which contains respective resources in this API group

operatorHub

OpenShiftOperatorHubAPIGroupDSL operatorHub()

API entrypoint for accessing OpenShift operator hub APIGroup resources(operator.coreos.com/v1alpha1)

Returns:

OpenShiftOperatorHubAPIGroupDSL which contains respective resources in this API group

extensions

ExtensionsAPIGroupDSL extensions()

Specified by:

extensions in interface KubernetesClient

getVersion

VersionInfo getVersion()

Specified by:

getVersion in interface KubernetesClient

apps

AppsAPIGroupDSL apps()

Specified by:

apps in interface KubernetesClient

autoscaling

AutoscalingAPIGroupDSL autoscaling()

Specified by:

autoscaling in interface KubernetesClient

monitoring

OpenShiftMonitoringAPIGroupDSL monitoring()

API entrypoint for accessing OpenShift operator APIGroup resources(monitoring.coreos.com/v1)

Returns:

OpenShiftMonitoringAPIGroupDSL which contains respective resources in this API group

netNamespaces

NonNamespaceOperation<io.fabric8.openshift.api.model.NetNamespace,io.fabric8.openshift.api.model.NetNamespaceList,Resource<io.fabric8.openshift.api.model.NetNamespace>> netNamespaces()

API entrypoint for handling NetNamespace(network.openshift.io/v1)

Returns:

NonNamespaceOperation instance for NetNamespace object

clusterNetworks

NonNamespaceOperation<io.fabric8.openshift.api.model.ClusterNetwork,io.fabric8.openshift.api.model.ClusterNetworkList,Resource<io.fabric8.openshift.api.model.ClusterNetwork>> clusterNetworks()

API entrypoint for handling ClusterNetwork(network.openshift.io/v1)

Returns:

NonNamespaceOperation instance for ClusterNetwork object

egressNetworkPolicies

MixedOperation<io.fabric8.openshift.api.model.EgressNetworkPolicy,io.fabric8.openshift.api.model.EgressNetworkPolicyList,Resource<io.fabric8.openshift.api.model.EgressNetworkPolicy>> egressNetworkPolicies()

API entrypoint for handling EgressNetworkPolicy(network.openshift.io/v1)

Returns:

MixedOperation instance for EgressNetworkPolicy object

network

NetworkAPIGroupDSL network()

Specified by:

network in interface KubernetesClient

storage

StorageAPIGroupDSL storage()

Specified by:

storage in interface KubernetesClient

batch

BatchAPIGroupDSL batch()

Specified by:

batch in interface KubernetesClient

rbac

RbacAPIGroupDSL rbac()

Specified by:

rbac in interface KubernetesClient

scheduling

SchedulingAPIGroupDSL scheduling()

Specified by:

scheduling in interface KubernetesClient

builds

MixedOperation<io.fabric8.openshift.api.model.Build,io.fabric8.openshift.api.model.BuildList,BuildResource<io.fabric8.openshift.api.model.Build,LogWatch>> 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

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

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

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

projects

ProjectOperation projects()

API entrypoint for accessing Project operations(project.openshift.io/v1)

Returns:

ProjectOperation for Project specific operations

projectrequests

ProjectRequestOperation projectrequests()

API entrypoint for accessing ProjectRequest operations(project.openshift.io/v1)

Returns:

ProjectRequestOperation for ProjectRequest specific operations

quotas

OpenShiftQuotaAPIGroupDSL quotas()

API entrypoint for accessing OpenShift Quota APIGroup resources(quota.openshift.io/v1)

Returns:

OpenShiftQuotaAPIGroupDSL which contains operations for respective resources inside the APIGroup

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

templates

ParameterMixedOperation<io.fabric8.openshift.api.model.Template,io.fabric8.openshift.api.model.TemplateList,TemplateResource<io.fabric8.openshift.api.model.Template,io.fabric8.kubernetes.api.model.KubernetesList>> templates()

API entrypoint for accessing Template(template.openshift.io/v1)

Returns:

ParameterMixedOperation object for Template operations

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()

localSubjectAccessReviews

OpenShiftLocalSubjectAccessReviewOperationsImpl localSubjectAccessReviews()

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

withRequestConfig

FunctionCallable<NamespacedOpenShiftClient> withRequestConfig(RequestConfig requestConfig)

Configure Request Config

Parameters:

requestConfig - request configuration for connection

Returns:

NamespacedOpenShiftClient configured with specified RequestConfig

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

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