OpenShift Java Client 2.5.0.Final

com.openshift.internal.client
Class EnvironmentVariableResource

java.lang.Object
  extended by com.openshift.internal.client.AbstractOpenShiftResource
      extended by com.openshift.internal.client.EnvironmentVariableResource
All Implemented Interfaces:
IEnvironmentVariable, IOpenShiftResource

public class EnvironmentVariableResource
extends AbstractOpenShiftResource
implements IEnvironmentVariable

Author:
Syed Iqbal

Nested Class Summary
 
Nested classes/interfaces inherited from class com.openshift.internal.client.AbstractOpenShiftResource
AbstractOpenShiftResource.Parameters, AbstractOpenShiftResource.ServiceRequest
 
Constructor Summary
protected EnvironmentVariableResource(EnvironmentVariableResourceDTO dto, ApplicationResource application)
           
protected EnvironmentVariableResource(String name, String value, Messages messages, Map<String,Link> links, ApplicationResource application)
           
 
Method Summary
 void destroy()
          Destroys this environment variable
 IApplication getApplication()
          Returns the application for this environment variable
 String getName()
           
 String getValue()
           
 void refresh()
          Refresh the resource and its list of children resources that were previously loaded
 String toString()
           
 void update(String newValue)
          Updates this environment variable to the given value.
 
Methods inherited from class com.openshift.internal.client.AbstractOpenShiftResource
getCreationLog, getLink, getMessages, hasCreationLog, setLinks
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.openshift.client.IOpenShiftResource
getCreationLog, getMessages, hasCreationLog
 

Constructor Detail

EnvironmentVariableResource

protected EnvironmentVariableResource(EnvironmentVariableResourceDTO dto,
                                      ApplicationResource application)

EnvironmentVariableResource

protected EnvironmentVariableResource(String name,
                                      String value,
                                      Messages messages,
                                      Map<String,Link> links,
                                      ApplicationResource application)
Method Detail

getName

public String getName()
Specified by:
getName in interface IEnvironmentVariable
Returns:
Name of the environment variable

getValue

public String getValue()
Specified by:
getValue in interface IEnvironmentVariable
Returns:
Value of the environment variable

update

public void update(String newValue)
            throws OpenShiftException
Description copied from interface: IEnvironmentVariable
Updates this environment variable to the given value.

Specified by:
update in interface IEnvironmentVariable
Parameters:
newValue - new value for this environment variable
Throws:
OpenShiftException

destroy

public void destroy()
             throws OpenShiftException
Description copied from interface: IEnvironmentVariable
Destroys this environment variable

Specified by:
destroy in interface IEnvironmentVariable
Throws:
OpenShiftException

refresh

public void refresh()
             throws OpenShiftException
Description copied from interface: IOpenShiftResource
Refresh the resource and its list of children resources that were previously loaded

Specified by:
refresh in interface IOpenShiftResource
Throws:
OpenShiftException

getApplication

public IApplication getApplication()
Description copied from interface: IEnvironmentVariable
Returns the application for this environment variable

Specified by:
getApplication in interface IEnvironmentVariable
Returns:

toString

public String toString()
Overrides:
toString in class Object

OpenShift Java Client 2.5.0.Final

Copyright © 2014 JBoss, a division of Red Hat, Inc.. All Rights Reserved.