com.openshift.internal.restclient.model

Class Pod

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

com.openshift.internal.restclient.model.Pod

All Implemented Interfaces:

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

public class Pod
extends KubernetesResource
implements IPod

Field Summary

Fields inherited from interface com.openshift.internal.restclient.model.properties.ResourcePropertyKeys

ANNOTATIONS, APIVERSION, CREATION_TIMESTAMP, FROM, KIND, LABELS, METADATA, METADATA_NAME, METADATA_NAMESPACE, METADATA_RESOURCE_VERSION, METADATA_UID, NAME, NAMESPACE, OBJECTS, PORTS, PROTOCOL, RESOURCE_VERSION, TYPE, VALUE

Constructor Summary

Constructors

Constructor and Description
Pod(org.jboss.dmr.ModelNode node, IClient client, Map<String,String[]> propertyKeys)

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() The logic of the method is a copied from 'podStatus' function of [app/scripts/filters/resources.js] of [openshift/origin-web-console]
boolean	isReady() Returns true if all containers of this pod are ready.

Methods inherited from class com.openshift.internal.restclient.model.KubernetesResource

accept, addLabel, asBoolean, asBoolean, asInt, asInt, asMap, asSet, asString, asString, equals, get, get, getAnnotation, getAnnotations, getApiVersion, getCapabilities, getCapability, getClient, getCreationTimeStamp, getEnvMap, getKind, getLabels, getMetadata, getModifiableCapabilities, getName, getNamespace, getNamespaceName, getNode, getPath, getProject, getPropertyKeys, getResourceVersion, has, hashCode, isAnnotatedWith, refresh, removeAnnotation, set, set, set, set, set, set, set, set, set, setAnnotation, setEnvMap, setName, setNamespace, setNode, supports, toJson, toJson, toPrettyString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

Pod

public Pod(org.jboss.dmr.ModelNode node,
           IClient client,
           Map<String,String[]> propertyKeys)

Method Detail

getIP

public String getIP()

Description copied from interface: IPod

Returns the IP of this pod.

Specified by:

getIP in interface IPod

Returns:

ip of this pod.

getHost

public String getHost()

Description copied from interface: IPod

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

Specified by:

getHost in interface IPod

Returns:

the hostname of this pod.

getImages

public Collection<String> getImages()

Description copied from interface: IPod

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

Specified by:

getImages in interface IPod

Returns:

the image names for the containers of this pod.

getStatus

public String getStatus()

The logic of the method is a copied from 'podStatus' function of [app/scripts/filters/resources.js] of [openshift/origin-web-console]

Specified by:

getStatus in interface IPod

Returns:

the status of this pod

getContainerPorts

public Set<IPort> getContainerPorts()

Description copied from interface: IPod

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

Specified by:

getContainerPorts in interface IPod

addContainer

public IContainer addContainer(String name)

Description copied from interface: IPod

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.

Specified by:

addContainer in interface IPod

Returns:

the container that was added.

getContainers

public Collection<IContainer> getContainers()

Description copied from interface: IPod

Returns all the containers for this pod.

Specified by:

getContainers in interface IPod

Returns:

the containers for this pod.

isReady

public boolean isReady()

Description copied from interface: IPod

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

Specified by:

isReady in interface IPod

Returns:

true if all containers are ready, false otherwise.