Class Docker::Exec
In: lib/docker/exec.rb
Parent: Object

This class represents a Docker Exec Instance.

Methods

create   json   resize   start!   to_s  

Included Modules

Docker::Base

Public Class methods

create(options = {}, conn = Docker.connection)

Create a new Exec instance in a running container. Please note, this does NOT execute the instance - you must run start. Also, each instance is one-time use only.

@param options [Hash] Parameters to pass in to the API. @param conn [Docker::Connection] Connection to Docker Remote API

@return [Docker::Exec] self

Public Instance methods

json()

Get info about the Exec instance

resize(query = {})

Resize the TTY associated with the Exec instance

@param query [Hash] API query parameters @option query [Fixnum] h Height of the TTY @option query [Fixnum] w Width of the TTY

@return [Docker::Exec] self

start!(options = {}, &block)

Start the Exec instance. The Exec instance is deleted after this so this command can only be run once.

@param options [Hash] Options to dictate behavior of the instance @option options [Object] :stdin (nil) The object to pass to STDIN. @option options [TrueClass, FalseClass] :detach (false) Whether to attach 

    to STDOUT/STDERR.

@option options [TrueClass, FalseClass] :tty (false) Whether to attach using 

    a pseudo-TTY.

@return [Array, Array, Int] The STDOUT, STDERR and exit code

to_s()

Convert details about the object into a string

@return [String] String representation of the Exec instance object

[Validate]