module Client:sig
..end
module Error:sig
..end
Error.t
is the type of the error kinds that this module introduces.
type
t
val as_client : configuration:Configuration.t ->
f:(client:t ->
('result,
[> `Database of Trakeva.Error.t
| `Database_unavailable of string
| `Dyn_plugin of [> `Dynlink_error of Dynlink.error | `Findlib of exn ]
| `Failure of string
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ]
| `Wrong_configuration of [> `Found of string ] * [> `Exn of exn ] ]
as 'a)
Unix_io.Deferred_result.t) ->
('result, 'a) Unix_io.Deferred_result.t
f
with a fresh-client created with the configuration
.
If the configuration can be for an HTTP client, for a standalone
engine, or for a server (the client behaves like a local standalone
engine, using Ketrew.Configuration.standalone_of_server
).
val configuration : t -> Configuration.t
val get_local_engine : t -> Engine.t option
None
if the client is
an HTTP one).val all_visible_targets : t ->
(Ketrew_pure.Target.t list,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of string
| `Fetching_node of Persistent_data.Error.fetching_node
| `IO of
[> `Read_file_exn of string * exn | `Write_file_exn of string * exn ]
| `System of [> `File_info of string ] * [> `Exn of exn ]
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
val get_list_of_target_ids : t ->
query:Ketrew_pure.Protocol.Up_message.target_query ->
(Ketrew_pure.Target.id list,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of string
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
query
.val get_target : t ->
id:Ketrew_pure.Target.id ->
(Ketrew_pure.Target.t,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of string
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
val get_targets : t ->
id_list:Ketrew_pure.Target.id list ->
(Ketrew_pure.Target.t list,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of string
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
Ketrew.Client.get_target
but “in bulk.”val call_query : t ->
target:Ketrew_pure.Target.t ->
string ->
(string, Ketrew_pure.Internal_pervasives.Log.t) Unix_io.Deferred_result.t
val kill : t ->
Ketrew_pure.Target.id list ->
(unit,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of Ketrew_pure.Target.id
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
val restart : t ->
Ketrew_pure.Target.id list ->
(unit,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of Ketrew_pure.Target.id
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
val add_targets : t ->
Ketrew_pure.Target.t list ->
(unit,
[> `Client of Error.t
| `Database of Trakeva.Error.t
| `Database_unavailable of string
| `Fetching_node of Persistent_data.Error.fetching_node
| `Target of [> `Deserilization of string ] ])
Unix_io.Deferred_result.t
Ketrew_pure.Target.t
values; for use in the EDSL please
see Ketrew.Client.submit_workflow
below.val call_process_holder : t ->
Ketrew_pure.Protocol.Process_sub_protocol.up ->
(Ketrew_pure.Protocol.Process_sub_protocol.down,
[> `Client of Error.t | `Failure of string ])
Unix_io.Deferred_result.t
val submit_workflow : ?override_configuration:Configuration.t ->
?add_tags:string list ->
< is_done : EDSL.Condition.t option; .. > EDSL.product EDSL.workflow_node ->
unit
Lwt_main.run
.
One can add tags to all the targets in the workflow before
submitting with the add_tags
option.
val submit : ?override_configuration:Configuration.t ->
?add_tags:string list -> EDSL.user_target -> unit
Ketrew.Client.submit_workflow
but for the deprecated/legacy API
(i.e. created with calls to Ketrew.EDSL.user_target
).