cli.api module

cli.api.deployment(args)[source]

Start a Deployment

  • Parameters

    args (Namespace) – arguments coming from the CLI.

cli.api.pod(args)[source]

Start a Pod

  • Parameters

    args (Namespace) – arguments coming from the CLI.

cli.api.executor_native(args)[source]

Starts an Executor in a WorkerRuntime

  • 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 pod or worker_runtime

cli.api.worker_runtime(args)[source]

Starts a WorkerRuntime

  • Parameters

    args (Namespace) – arguments coming from the CLI.

cli.api.gateway(args)[source]

Start a Gateway Deployment

  • Parameters

    args (Namespace) – arguments coming from the CLI.

cli.api.ping(args)[source]

Check the connectivity of a Pod

  • 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.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.