org.microbean.kubernetes

Class Pods

java.lang.Object

org.microbean.kubernetes.Pods

public final class Pods
extends Object

A utility class that helps with operations concerning Pods.

Author:

Laird Nelson

See Also:

forwardPort(OkHttpClient, Listable, int), isReady(Pod), Pod

Method Summary

Modifier and Type	Method and Description
static io.fabric8.kubernetes.client.LocalPortForward	forwardPort(OkHttpClient httpClient, io.fabric8.kubernetes.client.dsl.Listable<? extends io.fabric8.kubernetes.api.model.PodList> pods, int remotePort) Forwards an arbitrary local port to the supplied remotePort on the first ready Pod in the supplied Listable using the supplied OkHttpClient.
static io.fabric8.kubernetes.client.LocalPortForward	forwardPort(OkHttpClient httpClient, io.fabric8.kubernetes.client.dsl.Listable<? extends io.fabric8.kubernetes.api.model.PodList> pods, int remotePort, int localPort)
static io.fabric8.kubernetes.api.model.Pod	getFirstReadyPod(Iterable<? extends io.fabric8.kubernetes.api.model.Pod> pods) Returns the first Pod encountered in the supplied Iterable of Pods for which the isReady(Pod) method returns Boolean.TRUE, or null.
static io.fabric8.kubernetes.api.model.Pod	getFirstReadyPod(io.fabric8.kubernetes.client.dsl.Listable<? extends io.fabric8.kubernetes.api.model.PodList> podsResource) Returns the first Pod reachable from the supplied Listable of PodLists for which the isReady(Pod) method returns Boolean.TRUE, or null.
static io.fabric8.kubernetes.api.model.Pod	getFirstReadyPod(io.fabric8.kubernetes.api.model.PodList podList) Returns the first Pod encountered in the supplied PodList of Pods for which the isReady(Pod) method returns Boolean.TRUE, or null.
static Boolean	isReady(Iterable<? extends io.fabric8.kubernetes.api.model.PodCondition> podConditions) Returns Boolean.TRUE if the supplied Iterable of PodConditions contains a PodCondition whose PodCondition.getType() method returns Ready and whose PodCondition.getStatus() method returns True.
static Boolean	isReady(io.fabric8.kubernetes.api.model.Pod pod) Returns Boolean.TRUE if the supplied Pod is known to be ready, Boolean.FALSE if it is known to be not ready and null if its readiness status is unknown.
static Boolean	isReady(io.fabric8.kubernetes.api.model.PodStatus podStatus) Returns Boolean.TRUE if the supplied PodStatus is known to be ready, Boolean.FALSE if it is known to be not ready and null if its readiness status is unknown.

Methods inherited from class java.lang.Object

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

Method Detail

forwardPort

public static final io.fabric8.kubernetes.client.LocalPortForward forwardPort(OkHttpClient httpClient,
                                                                              io.fabric8.kubernetes.client.dsl.Listable<? extends io.fabric8.kubernetes.api.model.PodList> pods,
                                                                              int remotePort)
                                                                       throws MalformedURLException

Forwards an arbitrary local port to the supplied remotePort on the first ready Pod in the supplied Listable using the supplied OkHttpClient.

This method may return null.

Parameters:

httpClient - an OkHttpClient used to communicate with Kubernetes; may be null in which case null will be returned

pods - a Listable of PodLists; must also be an instance of OperationSupport or null will be returned

remotePort - the port on the Pod that is ultimately located to which traffic should be forwarded

Returns:

a LocalPortForward representing the port forwarding operation, or null; must be closed if non-null

Throws:

MalformedURLException - if a URL to the Kubernetes resource representing the Pod in question could not be constructed

See Also:

PortForwarderWebsocket.PortForwarderWebsocket(OkHttpClient), Pod conditions documentation

forwardPort

public static final io.fabric8.kubernetes.client.LocalPortForward forwardPort(OkHttpClient httpClient,
                                                                              io.fabric8.kubernetes.client.dsl.Listable<? extends io.fabric8.kubernetes.api.model.PodList> pods,
                                                                              int remotePort,
                                                                              int localPort)
                                                                       throws MalformedURLException

Throws:

MalformedURLException

isReady

public static final Boolean isReady(io.fabric8.kubernetes.api.model.Pod pod)

Returns Boolean.TRUE if the supplied Pod is known to be ready, Boolean.FALSE if it is known to be not ready and null if its readiness status is unknown.

This method may return null.

Parameters:

pod - the Pod to check; may be null in which case null will be returned

Returns:

Boolean.TRUE if the supplied Pod is known to be ready, Boolean.FALSE if it is known to be not ready and null if its readiness status is unknown

See Also:

isReady(PodStatus), Pod conditions documentation

isReady

public static final Boolean isReady(io.fabric8.kubernetes.api.model.PodStatus podStatus)

Returns Boolean.TRUE if the supplied PodStatus is known to be ready, Boolean.FALSE if it is known to be not ready and null if its readiness status is unknown.

This method may return null.

Parameters:

podStatus - the PodStatus to check; may be null in which case null will be returned

Returns:

Boolean.TRUE if the supplied PodStatus is known to be ready, Boolean.FALSE if it is known to be not ready and null if its readiness status is unknown

See Also:

isReady(Iterable), Pod conditions documentation

isReady

public static final Boolean isReady(Iterable<? extends io.fabric8.kubernetes.api.model.PodCondition> podConditions)

Returns Boolean.TRUE if the supplied Iterable of PodConditions contains a PodCondition whose PodCondition.getType() method returns Ready and whose PodCondition.getStatus() method returns True.

If the supplied Iterable of PodConditions also contains a PodCondition whose PodCondition.getType() method returns Ready and whose PodCondition.getStatus() method returns False, then null is returned.

If instead the supplied Iterable of PodConditions contains a PodCondition whose PodCondition.getType() method returns Ready and whose PodCondition.getStatus() method returns False and does not also contains a PodCondition whose PodCondition.getType() method returns Ready and whose PodCondition.getStatus() method returns True, then Boolean.FALSE is returned.

null is returned in all other cases.

This method may return null.

Parameters:

podConditions - an Iterable of PodConditions; may be null in which case null will be returned

Returns:

Boolean.TRUE if the supplied Iterable of PodConditions represents a state of affairs known to represent the readiness of the PodStatus they describe; Boolean.FALSE if the supplied Iterable of PodConditions represents a state of affairs known to represent the unreadiness of the PodStatus they describe, or null in all other cases

See Also:

Pod conditions documentation

getFirstReadyPod

public static final io.fabric8.kubernetes.api.model.Pod getFirstReadyPod(Iterable<? extends io.fabric8.kubernetes.api.model.Pod> pods)

Returns the first Pod encountered in the supplied Iterable of Pods for which the isReady(Pod) method returns Boolean.TRUE, or null.

This method may return null.

Parameters:

pods - an Iterable of Pods to check; may be null in which case null will be returned

Returns:

a Pod known to be ready, or null

See Also:

isReady(Pod), Pod conditions documentation

getFirstReadyPod

public static final io.fabric8.kubernetes.api.model.Pod getFirstReadyPod(io.fabric8.kubernetes.api.model.PodList podList)

Returns the first Pod encountered in the supplied PodList of Pods for which the isReady(Pod) method returns Boolean.TRUE, or null.

This method may return null.

Parameters:

podList - a PodList of Pods to check; may be null in which case null will be returned

Returns:

a Pod known to be ready, or null

See Also:

getFirstReadyPod(Iterable), isReady(Pod), Pod conditions documentation

getFirstReadyPod

public static final io.fabric8.kubernetes.api.model.Pod getFirstReadyPod(io.fabric8.kubernetes.client.dsl.Listable<? extends io.fabric8.kubernetes.api.model.PodList> podsResource)

Returns the first Pod reachable from the supplied Listable of PodLists for which the isReady(Pod) method returns Boolean.TRUE, or null.

This method may return null.

Parameters:

podsResource - a Listable of PodLists representing Pods to check; may be null in which case null will be returned

Returns:

a Pod known to be ready, or null

See Also:

getFirstReadyPod(PodList), isReady(Pod), Pod conditions documentation