Liking cljdoc? Tell your friends :D

clj-docker-client.core


categoriesclj

(categories)
(categories version)

Returns the available categories.

Takes an optional API version for specific ones.

Returns the available categories.

Takes an optional API version for specific ones.
sourceraw docstring

clientclj

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

Constructs a client for a specified category.

Returns the client.

Examples are: :containers, :images, etc

Constructs a client for a specified category.

Returns the client.

Examples are: :containers, :images, etc
sourceraw docstring

connectcljdeprecated

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

Deprecated but still there for compatibility reasons.

Deprecated but still there for compatibility reasons.
sourceraw docstring

docclj

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

Returns the doc of the supplied category and operation

Returns the doc of the supplied category and operation
sourceraw docstring

invokeclj

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

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.

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.
sourceraw docstring

opsclj

(ops client)

Returns the supported ops for a client.

Returns the supported ops for a client.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close