cli.api module

cli.api.pod(args)[source]

Start a Pod

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.pea(args)[source]

Start a Pea

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.executor_native(args)[source]

Starts an Executor in ZEDRuntime or GRPCDataRuntime depending on the runtime_cls

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.executor(args)[source]

Starts an Executor in any Runtime

Parameters

args (Namespace) – arguments coming from the CLI.

Returns

return the same as pea or zed_runtime

cli.api.grpc_data_runtime(args)[source]

Starts a GRPCDataRuntime

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.grpc_executor(args)

Starts a GRPCDataRuntime

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.gateway(args)[source]

Start a Gateway Pod

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.ping(args)[source]

Check the connectivity of a Pea

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.client(args)[source]

Start a client connects to the gateway

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.export_api(args)[source]

Export the API

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.hello(args)[source]

Run any of the hello world examples

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.flow(args)[source]

Start a Flow from a YAML file or a docker image

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.optimizer(args)[source]

Start an optimization from a YAML file

Parameters

args (Namespace) – arguments coming from the CLI.

cli.api.hub(args)[source]

Start a hub builder for push, pull :type args: Namespace :param args: arguments coming from the CLI.

cli.api.help(args)[source]

Lookup the usage of certain argument in Jina API.

Parameters

args (Namespace) – arguments coming from the CLI.