com.openshift.restclient.model

Interface IPod

All Superinterfaces:

Annotatable, IAnnotatable, IApiVersionable, ICapable, IKindable, IResource, ITypeMeta, JSONSerializeable

All Known Implementing Classes:

Pod

public interface IPod
extends IResource

Method Summary

Modifier and Type	Method and Description
IContainer	addContainer(String name) Adds a container with the given name.
Set<IPort>	getContainerPorts() Returns the ports that the containers of this pod are using.
Collection<IContainer>	getContainers() Returns all the containers for this pod.
String	getHost() Returns the hostname of the host on which the pod is running.
Collection<String>	getImages() Returns the names of the images that the containers of this pod are using.
String	getIP() Returns the IP of this pod.
String	getStatus() Returns the status of the pod.
boolean	isReady() Returns true if all containers of this pod are ready.

Methods inherited from interface com.openshift.restclient.model.IResource

addLabel, getAnnotation, getAnnotations, getCapabilities, getCreationTimeStamp, getLabels, getMetadata, getName, getNamespace, getNamespaceName, getProject, getResourceVersion, isAnnotatedWith, removeAnnotation, setAnnotation

Methods inherited from interface com.openshift.restclient.capability.ICapable

accept, getCapability, supports

Methods inherited from interface com.openshift.restclient.api.models.IApiVersionable

getApiVersion

Methods inherited from interface com.openshift.restclient.api.models.IKindable

getKind

Methods inherited from interface com.openshift.restclient.model.JSONSerializeable

toJson, toJson

Method Detail

getIP

String getIP()

Returns the IP of this pod.

Returns:

ip of this pod.

getHost

String getHost()

Returns the hostname of the host on which the pod is running.

Returns:

the hostname of this pod.

getImages

Collection<String> getImages()

Returns the names of the images that the containers of this pod are using.

Returns:

the image names for the containers of this pod.

getStatus

String getStatus()

Returns the status of the pod. The pod status is derived from the status of all it's containers. The current implementation is limited to the status of the 1st container though. The string that's returned is built out of different properties of the container:

• state.waiting.reason
• state.terminated.reason
,
• state.terminated.signal
• state.terminated.exitCode

Returns:

the status of this pod

getContainerPorts

Set<IPort> getContainerPorts()

Returns the ports that the containers of this pod are using.

addContainer

IContainer addContainer(String name)

Adds a container with the given name. This is useful if creating a pod directly without a resource controller. Returns the container for the given name.

Parameters:

the - name of the container

Returns:

the container that was added.

getContainers

Collection<IContainer> getContainers()

Returns all the containers for this pod.

Returns:

the containers for this pod.

isReady

boolean isReady()

Returns true if all containers of this pod are ready. false otherwise.

Returns:

true if all containers are ready, false otherwise.