org.openecomp.ncomp.docker

Interface DockerHost

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.openecomp.ncomp.core.NamedEntity, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

DockerHostImpl

public interface DockerHost
extends org.openecomp.ncomp.core.NamedEntity

A representation of the model object 'Host'.

The following features are supported:

• Url
• Polling Frequency
• Remote
• Images
• Containers
• Networks

See Also:

DockerPackage.getDockerHost()

Method Summary

Modifier and Type	Method and Description
void	containerProcesses(String name)
void	containerStats(String name, boolean stream)
void	dockerRun(String image)
void	dockerRunWithName(String image, String name)
void	dockerRunWithOptions(String image, ContainerOptions opts)
org.eclipse.emf.common.util.EList<DockerContainer>	getContainers() Returns the value of the 'Containers' containment reference list.
org.eclipse.emf.common.util.EList<DockerImage>	getImages() Returns the value of the 'Images' containment reference list.
org.eclipse.emf.common.util.EList<DockerNetwork>	getNetworks() Returns the value of the 'Networks' containment reference list.
long	getPollingFrequency() Returns the value of the 'Polling Frequency' attribute.
String	getUrl() Returns the value of the 'Url' attribute.
void	inspectContainer(String name)
boolean	isRemote() Returns the value of the 'Remote' attribute.
void	killContainer(String name, String sigint)
void	pauseContainer(String name)
void	poll()
void	removeContainer(String name, boolean remove, boolean force)
void	restartContainer(String name, int seconds)
void	setPollingFrequency(long value) Sets the value of the 'Polling Frequency' attribute.
void	setRemote(boolean value) Sets the value of the 'Remote' attribute.
void	setUrl(String value) Sets the value of the 'Url' attribute.
void	startContainer(String name)
void	stopContainer(String name, int seconds)
void	unpauseContainer(String name)

Methods inherited from interface org.openecomp.ncomp.core.NamedEntity

getCreated, getLastChanged, getLastPolled, getName, setCreated, setLastChanged, setLastPolled, setName

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getUrl

String getUrl()

Returns the value of the 'Url' attribute.

If the meaning of the 'Url' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Url' attribute.

See Also:

setUrl(String), DockerPackage.getDockerHost_Url()

setUrl

void setUrl(String value)

Sets the value of the 'Url' attribute.

Parameters:

value - the new value of the 'Url' attribute.

See Also:

getUrl()

getPollingFrequency

long getPollingFrequency()

Returns the value of the 'Polling Frequency' attribute. The default value is "30000".

If the meaning of the 'Polling Frequency' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Polling Frequency' attribute.

See Also:

setPollingFrequency(long), DockerPackage.getDockerHost_PollingFrequency()

setPollingFrequency

void setPollingFrequency(long value)

Sets the value of the 'Polling Frequency' attribute.

Parameters:

value - the new value of the 'Polling Frequency' attribute.

See Also:

getPollingFrequency()

isRemote

boolean isRemote()

Returns the value of the 'Remote' attribute. The default value is "false".

If the meaning of the 'Remote' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Remote' attribute.

See Also:

setRemote(boolean), DockerPackage.getDockerHost_Remote()

setRemote

void setRemote(boolean value)

Sets the value of the 'Remote' attribute.

Parameters:

value - the new value of the 'Remote' attribute.

See Also:

isRemote()

getImages

org.eclipse.emf.common.util.EList<DockerImage> getImages()

Returns the value of the 'Images' containment reference list. The list contents are of type DockerImage.

If the meaning of the 'Images' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Images' containment reference list.

See Also:

DockerPackage.getDockerHost_Images()

getContainers

org.eclipse.emf.common.util.EList<DockerContainer> getContainers()

Returns the value of the 'Containers' containment reference list. The list contents are of type DockerContainer.

If the meaning of the 'Containers' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Containers' containment reference list.

See Also:

DockerPackage.getDockerHost_Containers()

getNetworks

org.eclipse.emf.common.util.EList<DockerNetwork> getNetworks()

Returns the value of the 'Networks' containment reference list. The list contents are of type DockerNetwork.

If the meaning of the 'Networks' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Networks' containment reference list.

See Also:

DockerPackage.getDockerHost_Networks()

poll

void poll()

startContainer

void startContainer(String name)

stopContainer

void stopContainer(String name,
                   int seconds)

restartContainer

void restartContainer(String name,
                      int seconds)

pauseContainer

void pauseContainer(String name)

unpauseContainer

void unpauseContainer(String name)

removeContainer

void removeContainer(String name,
                     boolean remove,
                     boolean force)

inspectContainer

void inspectContainer(String name)

killContainer

void killContainer(String name,
                   String sigint)

dockerRun

void dockerRun(String image)

dockerRunWithName

void dockerRunWithName(String image,
                       String name)

dockerRunWithOptions

void dockerRunWithOptions(String image,
                          ContainerOptions opts)

containerStats

void containerStats(String name,
                    boolean stream)

containerProcesses

void containerProcesses(String name)