Method Detail

• listContainers

  @Named(value="containers:list")
  @GET
  @Path(value="/containers/json")
  List<ContainerSummary> listContainers()

  Returns:

  a set of containers

• listContainers

  @Named(value="containers:list")
  @GET
  @Path(value="/containers/json")
  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")
  @POST
  @Path(value="/containers/create")
  Container createContainer(@QueryParam(value="name")
                                          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")
  @GET
  @Path(value="/containers/{id}/json")
  Container inspectContainer(@PathParam(value="id")
                                          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")
  @DELETE
  @Path(value="/containers/{id}")
  void removeContainer(@PathParam(value="id")
                                       String containerId)

  Parameters:

  containerId - The id of the container to be removed.

• removeContainer

  @Named(value="container:delete")
  @DELETE
  @Path(value="/containers/{id}")
  void removeContainer(@PathParam(value="id")
                                       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")
  @POST
  @Path(value="/containers/{id}/start")
  void startContainer(@PathParam(value="id")
                                    String containerId)

  Parameters:

  containerId - The id of the container to be started.

• startContainer

  @Named(value="container:start")
  @POST
  @Path(value="/containers/{id}/start")
  void startContainer(@PathParam(value="id")
                                    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")
  @POST
  @Path(value="/containers/{id}/stop")
  void stopContainer(@PathParam(value="id")
                                   String containerId)

  Parameters:

  containerId - The id of the container to be stopped.

• stopContainer

  @Named(value="container:stop")
  @POST
  @Path(value="/containers/{id}/stop")
  void stopContainer(@PathParam(value="id")
                                   String containerId,
                                   @QueryParam(value="t")
                                   int secondsToWait)

• commit

  @Named(value="container:commit")
  @POST
  @Path(value="/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")
  @POST
  @Path(value="/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")
  @POST
  @Path(value="/containers/{id}/pause")
  void pause(@PathParam(value="id")
                           String containerId)

  Parameters:

  containerId - The id of the container to be paused.

• unpause

  @Named(value="container:unpause")
  @POST
  @Path(value="/containers/{id}/unpause")
  void unpause(@PathParam(value="id")
                             String containerId)

  Parameters:

  containerId - The id of the container to be unpaused.

• attach

  @Named(value="container:attach")
  @POST
  @Path(value="/containers/{id}/attach")
  InputStream attach(@PathParam(value="id")
                                   String containerId)

  Parameters:

  containerId - The id of the container to be attached.

• attach

  @Named(value="container:attach")
  @POST
  @Path(value="/containers/{id}/attach")
  InputStream attach(@PathParam(value="id")
                                   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")
  @POST
  @Path(value="/containers/{id}/wait")
  StatusCode wait(@PathParam(value="id")
                                String containerId)

  Block until container @param containerId stops, then returns the exit code

• restart

  @Named(value="container:restart")
  @POST
  @Path(value="/containers/{id}/restart")
  void restart(@PathParam(value="id")
                             String containerId)

  Parameters:

  containerId - restarts

• restart

  @Named(value="container:restart")
  @POST
  @Path(value="/containers/{id}/restart")
  void restart(@PathParam(value="id")
                             String containerId,
                             @QueryParam(value="t")
                             int secondsToWait)

• kill

  @Named(value="container:kill")
  @POST
  @Path(value="/containers/{id}/kill")
  void kill(@PathParam(value="id")
                          String containerId)

  Parameters:

  containerId - to be killed

• kill

  @Named(value="container:kill")
  @POST
  @Path(value="/containers/{id}/kill")
  void kill(@PathParam(value="id")
                          String containerId,
                          @QueryParam(value="signal")
                          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")
  @POST
  @Path(value="/containers/{id}/kill")
  void kill(@PathParam(value="id")
                          String containerId,
                          @QueryParam(value="signal")
                          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")
  @POST
  @Path(value="/containers/{id}/copy")
  InputStream copy(@PathParam(value="id")
                                 String containerId,
                                 Resource resource)

  Parameters:

  containerId - id of the container to copy files from