clj-docker-client.core — lispyclouds/clj-docker-client 1.0.0

categories clj

(categories)

(categories version)

Returns the available categories.

Takes an optional API version for specific ones.

client clj

(client {:keys [category conn api-version] :as args})

Constructs a client for a specified category.

Returns the client.

Examples are: :containers, :images, etc

connect clj deprecated

(connect {:keys [uri connect-timeout read-timeout write-timeout call-timeout]})

Deprecated but still there for compatibility reasons.

doc clj

(doc {:keys [category api-version]} operation)

Returns the doc of the supplied category and operation

invoke clj

(invoke {:keys [category conn api-version]}
        {:keys [op params as throw-exception?]})

Performs the operation with the specified client and a map of options.

Returns the resulting map.

Options are: :op specifying the operation to invoke. Required. :params specifying the params to be passed to the :op. :as specifying the result. Can be either of :stream, :socket, :data. Defaults to :data. :throw-exception? Throws a RuntimeException when a response has a status >= 400. Defaults to false. Standard connection exceptions may still be thrown regardless.

If a :socket is requested, the underlying UNIX socket is returned.

ops clj

(ops client)

Returns the supported ops for a client.