com.openshift.restclient.model

Interface IReplicationController

All Superinterfaces:

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

All Known Subinterfaces:

IDeploymentConfig

All Known Implementing Classes:

DeploymentConfig, ReplicationController

public interface IReplicationController
extends IResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEPLOYMENT_PHASE

Method Summary

Modifier and Type	Method and Description
IContainer	addContainer(DockerImageURI tag, Set<IPort> containerPorts, Map<String,String> envVars) Add a container to the pod that will be spun up as part of this deployment, defaulting the name to the image name
IContainer	addContainer(String name) Add a container with the given name
IContainer	addContainer(String name, DockerImageURI tag, Set<IPort> containerPorts, Map<String,String> envVars, List<String> volumes) Add a container to the pod that will be spun up as part of this deployment.
void	addTemplateLabel(String key, String value) Add or update a label to the template spec;
void	addVolume(IVolumeSource volumeSource) Adds a volume to the pod spec.
<T extends IVolumeSource> T	addVolume(String volumetype, String name) Add a volume source of the given type with the given name.
IContainer	getContainer(String name) Retrieve a container by name or null if it is not found
Collection<IContainer>	getContainers() Retrieve the containers defined in spec
int	getCurrentReplicaCount() Returns the current number of replicas
int	getDesiredReplicaCount() Returns the desired number of replicas
Collection<IEnvironmentVariable>	getEnvironmentVariables() Return the list of env vars of the first container
Collection<IEnvironmentVariable>	getEnvironmentVariables(String containerName) Return the list of env vars for the given container or an empty list if the container is not found
Collection<String>	getImages() Retrieves the list of images deployed in the pod containers from this controller
int	getReplicas()
Map<String,String>	getReplicaSelector() Returns the selector used by the controller
String	getServiceAccountName() Retrieves the service account used by the controller
Map<String,String>	getTemplateLabels() Returns the labels for the template in this replication controller
Set<IVolumeSource>	getVolumes() The volumes associated with the pod spec
void	removeEnvironmentVariable(String name) Removes an environment variable with the given name.
void	removeEnvironmentVariable(String containerName, String name) Removes an environment variable with the given name and value on the given container.
void	setContainers(Collection<IContainer> containers)
void	setDesiredReplicaCount(int numOfReplicas) Sets a new desired number of replicas
void	setEnvironmentVariable(String name, String value) Set an environment variable to the given name and value on the first container in the list of containers
void	setEnvironmentVariable(String containerName, String name, String value) Set an environment variable to the given name and value on the given container.
void	setReplicas(int count)
void	setReplicaSelector(Map<String,String> selector) Set the selector using the map of values
void	setReplicaSelector(String key, String value)
void	setServiceAccountName(String serviceAccount) Sets the service account to run this replication controller under.
void	setVolumes(Set<IVolumeSource> volumes) Sets the volumes associated with the pod spec.

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

Field Detail

DEPLOYMENT_PHASE

static final String DEPLOYMENT_PHASE

See Also:

Constant Field Values

Method Detail

setEnvironmentVariable

void setEnvironmentVariable(String name,
                            String value)

Set an environment variable to the given name and value on the first container in the list of containers

setEnvironmentVariable

void setEnvironmentVariable(String containerName,
                            String name,
                            String value)

Set an environment variable to the given name and value on the given container. Returns silently if the containerName is not found

removeEnvironmentVariable

void removeEnvironmentVariable(String name)

Removes an environment variable with the given name. Returns silently if the name is not found

Throws:

IllegalArgumentException - if name is null

removeEnvironmentVariable

void removeEnvironmentVariable(String containerName,
                               String name)

Removes an environment variable with the given name and value on the given container. Returns silently if the containerName or the name is not found

Throws:

IllegalArgumentException - if name is null

getEnvironmentVariables

Collection<IEnvironmentVariable> getEnvironmentVariables()

Return the list of env vars of the first container

getEnvironmentVariables

Collection<IEnvironmentVariable> getEnvironmentVariables(String containerName)

Return the list of env vars for the given container or an empty list if the container is not found

getDesiredReplicaCount

int getDesiredReplicaCount()

Returns the desired number of replicas

getReplicas

int getReplicas()

setReplicas

void setReplicas(int count)

setDesiredReplicaCount

void setDesiredReplicaCount(int numOfReplicas)

Sets a new desired number of replicas

Parameters:

new - number of replicas

getCurrentReplicaCount

int getCurrentReplicaCount()

Returns the current number of replicas

getReplicaSelector

Map<String,String> getReplicaSelector()

Returns the selector used by the controller

setReplicaSelector

void setReplicaSelector(Map<String,String> selector)

Set the selector using the map of values

setReplicaSelector

void setReplicaSelector(String key,
                        String value)

getImages

Collection<String> getImages()

Retrieves the list of images deployed in the pod containers from this controller

addContainer

IContainer addContainer(String name,
                        DockerImageURI tag,
                        Set<IPort> containerPorts,
                        Map<String,String> envVars,
                        List<String> volumes)

Add a container to the pod that will be spun up as part of this deployment.

Parameters:

name - the name of the container

tag - the docker uri

containerPorts - the container ports

volumes - the set of emptyDir volumes to add to the config

addContainer

IContainer addContainer(DockerImageURI tag,
                        Set<IPort> containerPorts,
                        Map<String,String> envVars)

Add a container to the pod that will be spun up as part of this deployment, defaulting the name to the image name

Parameters:

tag - the docker uri

containerPorts - the container ports

addContainer

IContainer addContainer(String name)

Add a container with the given name

getContainer

IContainer getContainer(String name)

Retrieve a container by name or null if it is not found

Returns:

the container or null if not found

getContainers

Collection<IContainer> getContainers()

Retrieve the containers defined in spec

Returns:

collection of containers or empty collection

getTemplateLabels

Map<String,String> getTemplateLabels()

Returns the labels for the template in this replication controller

addTemplateLabel

void addTemplateLabel(String key,
                      String value)

Add or update a label to the template spec;

getVolumes

Set<IVolumeSource> getVolumes()

The volumes associated with the pod spec

addVolume

void addVolume(IVolumeSource volumeSource)

Adds a volume to the pod spec. If a volume with the same name already exists, the volume is not added.

Parameters:

volumeSource - The volume to add to the pod spec

addVolume

<T extends IVolumeSource> T addVolume(String volumetype,
                                      String name)

Add a volume source of the given type with the given name. Unimplemented types will return a generic volumesource impl

Parameters:

volumetype -

name -

Returns:

setVolumes

void setVolumes(Set<IVolumeSource> volumes)

Sets the volumes associated with the pod spec. Existing volumes will be overwritten.

Parameters:

volumes - The volumes to assign to the pod spec.

setContainers

void setContainers(Collection<IContainer> containers)

setServiceAccountName

void setServiceAccountName(String serviceAccount)

Sets the service account to run this replication controller under.

Parameters:

volumes - The service account to assign to the spec.

getServiceAccountName

String getServiceAccountName()

Retrieves the service account used by the controller