io.kubernetes.client.extended.kubectl

Class KubectlPortForward

java.lang.Object

io.kubernetes.client.extended.kubectl.KubectlPortForward

All Implemented Interfaces:

Kubectl.Executable<Boolean>

public class KubectlPortForward
extends Object
implements Kubectl.Executable<Boolean>

Method Summary

Modifier and Type	Method and Description
T	apiClient(io.kubernetes.client.openapi.ApiClient apiClient)
T	container(String container)
Boolean	execute() Run and retrieve the output from the kubectl helpers.
protected io.kubernetes.client.util.generic.GenericKubernetesApi<ApiType,io.kubernetes.client.common.KubernetesListObject>	getGenericApi()
protected <ApiType extends io.kubernetes.client.common.KubernetesObject> io.kubernetes.client.util.generic.GenericKubernetesApi<ApiType,? extends io.kubernetes.client.common.KubernetesListObject>	getGenericApi(Class<ApiType> apiTypeClass)
protected <ApiType extends io.kubernetes.client.common.KubernetesObject,ApiListType extends io.kubernetes.client.common.KubernetesListObject> io.kubernetes.client.util.generic.GenericKubernetesApi<ApiType,ApiListType>	getGenericApi(Class<ApiType> apiTypeClass, Class<ApiListType> apiListTypeClass)
T	name(String name)
T	namespace(String namespace)
KubectlPortForward	ports(int localPort, int targetPort) Add a port pair
protected void	refreshDiscovery()
void	shutdown()
T	skipDiscovery()

Methods inherited from class java.lang.Object

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

Method Detail

ports

public KubectlPortForward ports(int localPort,
                                int targetPort)

Add a port pair

Parameters:

localPort - The port to listen to on the local machine

targetPort - The port to connect to on the target Pod

execute

public Boolean execute()
                throws KubectlException

Description copied from interface: Kubectl.Executable

Run and retrieve the output from the kubectl helpers.

Specified by:

execute in interface Kubectl.Executable<Boolean>

Returns:

the output, can be Void

Throws:

KubectlException - the kubectl exception

shutdown

public void shutdown()

container

public T container(String container)

name

public T name(String name)

getGenericApi

protected io.kubernetes.client.util.generic.GenericKubernetesApi<ApiType,io.kubernetes.client.common.KubernetesListObject> getGenericApi()

namespace

public T namespace(String namespace)

refreshDiscovery

protected void refreshDiscovery()
                         throws KubectlException

Throws:

KubectlException

getGenericApi

protected <ApiType extends io.kubernetes.client.common.KubernetesObject> io.kubernetes.client.util.generic.GenericKubernetesApi<ApiType,? extends io.kubernetes.client.common.KubernetesListObject> getGenericApi(Class<ApiType> apiTypeClass)
                                                                                                                                                                                                           throws KubectlException

Throws:

KubectlException

getGenericApi

protected <ApiType extends io.kubernetes.client.common.KubernetesObject,ApiListType extends io.kubernetes.client.common.KubernetesListObject> io.kubernetes.client.util.generic.GenericKubernetesApi<ApiType,ApiListType> getGenericApi(Class<ApiType> apiTypeClass,
                                                                                                                                                                                                                                        Class<ApiListType> apiListTypeClass)

apiClient

public T apiClient(io.kubernetes.client.openapi.ApiClient apiClient)

skipDiscovery

public T skipDiscovery()