Package org.csanchez.jenkins.plugins.kubernetes

Class PodContainerSource

java.lang.Object

org.csanchez.jenkins.plugins.kubernetes.PodContainerSource

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

PodContainerSource.DefaultPodContainerSource

public abstract class PodContainerSource
extends Object
implements ExtensionPoint

Pod container sources are responsible to locating details about Pod containers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PodContainerSource.DefaultPodContainerSource	Default implementation of PodContainerSource that only searches the primary pod containers.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
PodContainerSource()

Method Summary

Modifier and Type	Method	Description
static List<PodContainerSource>	all()	Lookup all PodContainerSource extensions.
abstract Optional<io.fabric8.kubernetes.api.model.ContainerStatus>	getContainerStatus(io.fabric8.kubernetes.api.model.Pod pod, String containerName)	Lookup the status of the named container.
abstract Optional<String>	getContainerWorkingDir(io.fabric8.kubernetes.api.model.Pod pod, String containerName)	Lookup the working directory of the named container.
static Optional<io.fabric8.kubernetes.api.model.ContainerStatus>	lookupContainerStatus(io.fabric8.kubernetes.api.model.Pod pod, String containerName)	Lookup container status (either main container or ephemeral container).
static Optional<String>	lookupContainerWorkingDir(io.fabric8.kubernetes.api.model.Pod pod, String containerName)	Lookup pod container working dir.

Methods inherited from class java.lang.Object

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

Constructor Details

PodContainerSource

public PodContainerSource()

Method Details

getContainerWorkingDir

public abstract Optional<String> getContainerWorkingDir(@NonNull
 io.fabric8.kubernetes.api.model.Pod pod,
 @NonNull
 String containerName)

Lookup the working directory of the named container.

Parameters:

pod - pod reference to lookup container in

containerName - name of container to lookup

Returns:

working directory path if container found and working dir specified, otherwise empty

getContainerStatus

public abstract Optional<io.fabric8.kubernetes.api.model.ContainerStatus> getContainerStatus(@NonNull
 io.fabric8.kubernetes.api.model.Pod pod,
 @NonNull
 String containerName)

Lookup the status of the named container.

Parameters:

pod - pod reference to lookup container in

containerName - name of container to lookup

Returns:

container status if found, otherwise empty

all

@NonNull
public static List<PodContainerSource> all()

Lookup all PodContainerSource extensions.

Returns:

pod container source extension list

lookupContainerWorkingDir

public static Optional<String> lookupContainerWorkingDir(@NonNull
 io.fabric8.kubernetes.api.model.Pod pod,
 @NonNull
 String containerName)

Lookup pod container working dir. Searches all PodContainerSource extensions and returns the first non-empty result.

Parameters:

pod - pod to inspect

containerName - container to search for

Returns:

optional working dir if container found and working dir, possibly empty

lookupContainerStatus

public static Optional<io.fabric8.kubernetes.api.model.ContainerStatus> lookupContainerStatus(io.fabric8.kubernetes.api.model.Pod pod,
 String containerName)

Lookup container status (either main container or ephemeral container).

Parameters:

pod - pod resource to inspect

containerName - container to locate

Returns:

container status if found