/*-
* ============LICENSE_START==========================================
* OPENECOMP - DCAE
* ===================================================================
* Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
* ===================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END============================================
*/
/**
*/
package org.openecomp.ncomp.docker;
import org.openecomp.ncomp.core.NamedEntity;
import org.eclipse.emf.common.util.EList;
/**
*
* A representation of the model object 'Host'.
*
*
*
* The following features are supported:
*
* - {@link org.openecomp.ncomp.docker.DockerHost#getUrl Url}
* - {@link org.openecomp.ncomp.docker.DockerHost#getPollingFrequency Polling Frequency}
* - {@link org.openecomp.ncomp.docker.DockerHost#isRemote Remote}
* - {@link org.openecomp.ncomp.docker.DockerHost#getImages Images}
* - {@link org.openecomp.ncomp.docker.DockerHost#getContainers Containers}
* - {@link org.openecomp.ncomp.docker.DockerHost#getNetworks Networks}
*
*
*
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost()
* @model
* @generated
*/
public interface DockerHost extends NamedEntity {
/**
* 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...
*
*
* @return the value of the 'Url' attribute.
* @see #setUrl(String)
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost_Url()
* @model unique="false"
* @generated
*/
String getUrl();
/**
* Sets the value of the '{@link org.openecomp.ncomp.docker.DockerHost#getUrl Url}' attribute.
*
*
* @param value the new value of the 'Url' attribute.
* @see #getUrl()
* @generated
*/
void setUrl(String value);
/**
* 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...
*
*
* @return the value of the 'Polling Frequency' attribute.
* @see #setPollingFrequency(long)
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost_PollingFrequency()
* @model default="30000" unique="false"
* @generated
*/
long getPollingFrequency();
/**
* Sets the value of the '{@link org.openecomp.ncomp.docker.DockerHost#getPollingFrequency Polling Frequency}' attribute.
*
*
* @param value the new value of the 'Polling Frequency' attribute.
* @see #getPollingFrequency()
* @generated
*/
void setPollingFrequency(long value);
/**
* 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...
*
*
* @return the value of the 'Remote' attribute.
* @see #setRemote(boolean)
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost_Remote()
* @model default="false" unique="false"
* @generated
*/
boolean isRemote();
/**
* Sets the value of the '{@link org.openecomp.ncomp.docker.DockerHost#isRemote Remote}' attribute.
*
*
* @param value the new value of the 'Remote' attribute.
* @see #isRemote()
* @generated
*/
void setRemote(boolean value);
/**
* Returns the value of the 'Images' containment reference list.
* The list contents are of type {@link org.openecomp.ncomp.docker.DockerImage}.
*
*
* If the meaning of the 'Images' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Images' containment reference list.
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost_Images()
* @model containment="true"
* @generated
*/
EList getImages();
/**
* Returns the value of the 'Containers' containment reference list.
* The list contents are of type {@link org.openecomp.ncomp.docker.DockerContainer}.
*
*
* If the meaning of the 'Containers' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Containers' containment reference list.
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost_Containers()
* @model containment="true"
* @generated
*/
EList getContainers();
/**
* Returns the value of the 'Networks' containment reference list.
* The list contents are of type {@link org.openecomp.ncomp.docker.DockerNetwork}.
*
*
* If the meaning of the 'Networks' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Networks' containment reference list.
* @see org.openecomp.ncomp.docker.DockerPackage#getDockerHost_Networks()
* @model containment="true"
* @generated
*/
EList getNetworks();
/**
*
*
* @model
* @generated
*/
void poll();
/**
*
*
* @model nameUnique="false"
* @generated
*/
void startContainer(String name);
/**
*
*
* @model nameUnique="false" secondsUnique="false"
* @generated
*/
void stopContainer(String name, int seconds);
/**
*
*
* @model nameUnique="false" secondsUnique="false"
* @generated
*/
void restartContainer(String name, int seconds);
/**
*
*
* @model nameUnique="false"
* @generated
*/
void pauseContainer(String name);
/**
*
*
* @model nameUnique="false"
* @generated
*/
void unpauseContainer(String name);
/**
*
*
* @model nameUnique="false" removeUnique="false" forceUnique="false"
* @generated
*/
void removeContainer(String name, boolean remove, boolean force);
/**
*
*
* @model nameUnique="false"
* @generated
*/
void inspectContainer(String name);
/**
*
*
* @model nameUnique="false" sigintUnique="false"
* @generated
*/
void killContainer(String name, String sigint);
/**
*
*
* @model imageUnique="false"
* @generated
*/
void dockerRun(String image);
/**
*
*
* @model imageUnique="false" nameUnique="false"
* @generated
*/
void dockerRunWithName(String image, String name);
/**
*
*
* @model imageUnique="false" optsUnique="false"
* @generated
*/
void dockerRunWithOptions(String image, ContainerOptions opts);
/**
*
*
* @model nameUnique="false" streamUnique="false"
* @generated
*/
void containerStats(String name, boolean stream);
/**
*
*
* @model nameUnique="false"
* @generated
*/
void containerProcesses(String name);
} // DockerHost