com.openshift.internal.restclient.model.template

Class Template

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

com.openshift.internal.restclient.model.template.Template

All Implemented Interfaces:

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

public class Template
extends KubernetesResource
implements ITemplate

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, NAME, NAMESPACE, OBJECTS, PORTS, PROTOCOL, RESOURCE_VERSION, TYPE, VALUE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addObjectLabel(String key, String value) Add or update a label that is applied to the objects of the template when it is processed
Map<String,String>	getObjectLabels() Retrieves the labels that are applied to the objects of the template when it is processed.
Collection<IResource>	getObjects() Retrieves the list of resources this template creates
Map<String,IParameter>	getParameters() Returns a map of parameter names to parameters.
boolean	isMatching(String text) Returns true if this template contains the given text in name or tags.
void	updateParameter(String key, String value) Update a parameter if it exists
void	updateParameterValues(Collection<IParameter> parameters) Update the template's parameter values, with the values from the collection if a parameter with the same name is found

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

Template

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

Method Detail

getObjectLabels

public Map<String,String> getObjectLabels()

Description copied from interface: ITemplate

Retrieves the labels that are applied to the objects of the template when it is processed.

Specified by:

getObjectLabels in interface ITemplate

Returns:

Unmodifiable map of the item labels

addObjectLabel

public void addObjectLabel(String key,
                           String value)

Description copied from interface: ITemplate

Add or update a label that is applied to the objects of the template when it is processed

Specified by:

addObjectLabel in interface ITemplate

getParameters

public Map<String,IParameter> getParameters()

Description copied from interface: ITemplate

Returns a map of parameter names to parameters.

Specified by:

getParameters in interface ITemplate

getObjects

public Collection<IResource> getObjects()

Description copied from interface: ITemplate

Retrieves the list of resources this template creates

Specified by:

getObjects in interface ITemplate

updateParameterValues

public void updateParameterValues(Collection<IParameter> parameters)

Description copied from interface: ITemplate

Update the template's parameter values, with the values from the collection if a parameter with the same name is found

Specified by:

updateParameterValues in interface ITemplate

updateParameter

public void updateParameter(String key,
                            String value)

Description copied from interface: ITemplate

Update a parameter if it exists

Specified by:

updateParameter in interface ITemplate

isMatching

public boolean isMatching(String text)

Returns true if this template contains the given text in name or tags.

Specified by:

isMatching in interface ITemplate