ContainerApi (Apache jclouds 2.0.0 API)

```
public interface ContainerApi
```

Method Summary

Methods
Modifier and Type	Method and Description
`InputStream`	`attach(String containerId)`
`InputStream`	`attach(String containerId, AttachOptions options)`
`Image`	`commit()` Create a new image from a container’s changes
`Image`	`commit(CommitOptions options)` Create a new image from a container’s changes
`InputStream`	`copy(String containerId, Resource resource)`
`Container`	`createContainer(String name, Config config)`
`Container`	`inspectContainer(String containerId)` Return low-level information on the container id
`void`	`kill(String containerId)`
`void`	`kill(String containerId, int signal)`
`void`	`kill(String containerId, String signal)`
`List<ContainerSummary>`	`listContainers()`
`List<ContainerSummary>`	`listContainers(ListContainerOptions options)`
`void`	`pause(String containerId)`
`void`	`removeContainer(String containerId)`
`void`	`removeContainer(String containerId, RemoveContainerOptions options)`
`void`	`restart(String containerId)`
`void`	`restart(String containerId, int secondsToWait)`
`void`	`startContainer(String containerId)`
`void`	`startContainer(String containerId, HostConfig hostConfig)`
`void`	`stopContainer(String containerId)`
`void`	`stopContainer(String containerId, int secondsToWait)`
`void`	`unpause(String containerId)`
`StatusCode`	`wait(String containerId)` Block until container @param containerId stops, then returns the exit code

- Method Detail
  - listContainers
```
@Named(value="containers:list")
List<ContainerSummary> listContainers()
```
    Returns:
    a set of containers
  - listContainers
```
@Named(value="containers:list")
List<ContainerSummary> listContainers(ListContainerOptions options)
```
    Parameters:
    options - the options to list the containers (@see ListContainerOptions)
    
    Returns:
    a set of containers
  - createContainer
```
@Named(value="container:create")
Container createContainer(String name,
                              Config config)
```
    Parameters:
    name - the name for the new container. Must match /?[a-zA-Z0-9_-]+.
    config - the container’s configuration (@see BindToJsonPayload)
    
    Returns:
    a new container
  - inspectContainer
```
@Named(value="container:inspect")
Container inspectContainer(String containerId)
```
    Return low-level information on the container id
    
    Parameters:
    containerId - The id of the container to get.
    
    Returns:
    The details of the container or null if the container with the given id doesn't exist.
  - removeContainer
```
@Named(value="container:delete")
void removeContainer(String containerId)
```
    Parameters:
    containerId - The id of the container to be removed.
  - removeContainer
```
@Named(value="container:delete")
void removeContainer(String containerId,
                         RemoveContainerOptions options)
```
    Parameters:
    containerId - The id of the container to be removed.
    options - the operation’s configuration (@see RemoveContainerOptions)
  - startContainer
```
@Named(value="container:start")
void startContainer(String containerId)
```
    Parameters:
    containerId - The id of the container to be started.
  - startContainer
```
@Named(value="container:start")
void startContainer(String containerId,
                        HostConfig hostConfig)
```
    Parameters:
    containerId - The id of the container to be started.
    hostConfig - the container’s host configuration
  - stopContainer
```
@Named(value="container:stop")
void stopContainer(String containerId)
```
    Parameters:
    containerId - The id of the container to be stopped.
  - stopContainer
```
@Named(value="container:stop")
void stopContainer(String containerId,
                       int secondsToWait)
```
  - commit
```
@Named(value="container:commit")
Image commit()
```
    Create a new image from a container’s changes
    
    Returns:
    a new image created from the current container's status.
  - commit
```
@Named(value="container:commit")
Image commit(CommitOptions options)
```
    Create a new image from a container’s changes
    
    Parameters:
    options - the commit’s configuration (@see CommitOptions)
    
    Returns:
    a new image created from the current container's status.
  - pause
```
@Named(value="container:pause")
void pause(String containerId)
```
    Parameters:
    containerId - The id of the container to be paused.
  - unpause
```
@Named(value="container:unpause")
void unpause(String containerId)
```
    Parameters:
    containerId - The id of the container to be unpaused.
  - attach
```
@Named(value="container:attach")
InputStream attach(String containerId)
```
    Parameters:
    containerId - The id of the container to be attached.
  - attach
```
@Named(value="container:attach")
InputStream attach(String containerId,
                       AttachOptions options)
```
    Parameters:
    containerId - The id of the container to be attached.
    options - the attach options @see org.jclouds.docker.options.AttachOptions
  - wait
```
@Named(value="container:wait")
StatusCode wait(String containerId)
```
    Block until container @param containerId stops, then returns the exit code
  - restart
```
@Named(value="container:restart")
void restart(String containerId)
```
    Parameters:
    containerId - restarts
  - restart
```
@Named(value="container:restart")
void restart(String containerId,
                 int secondsToWait)
```
  - kill
```
@Named(value="container:kill")
void kill(String containerId)
```
    Parameters:
    containerId - to be killed
  - kill
```
@Named(value="container:kill")
void kill(String containerId,
              int signal)
```
    Parameters:
    containerId - to be killed
    signal - Signal to send to the container. When not set, SIGKILL is assumed and the call will waits for the container to exit.
  - kill
```
@Named(value="container:kill")
void kill(String containerId,
              String signal)
```
    Parameters:
    containerId - to be killed
    signal - Signal string like "SIGINT" to send to the container. When not set, SIGKILL is assumed and the call will waits for the container to exit.
  - copy
```
@Named(value="container:copy")
InputStream copy(String containerId,
                     Resource resource)
```
    Parameters:
    containerId - id of the container to copy files from

Interface ContainerApi

Method Summary

Method Detail

listContainers

listContainers

createContainer

inspectContainer

removeContainer

removeContainer

startContainer

startContainer

stopContainer

stopContainer

commit

commit

pause

unpause

attach

attach

wait

restart

restart

kill

kill

kill

copy