0.9.20.yml

name: Jina
description: Jina is the cloud-native neural search solution powered by state-of-the-art
  AI and deep learning technology
license: Apache 2.0
vendor: Jina AI Limited
source: https://github.com/jina-ai/jina/tree/master
url: https://jina.ai
docs: https://docs.jina.ai
authors: dev-team@jina.ai
version: 0.9.20
methods:
- name: hello-world
  options:
  - help: The workdir for hello-world demoall data, indices, shards and outputs will
      be saved there
    choices: null
    default: d04008aa-12bf-425d-baf8-a27c91c8151f
    required: false
    option_strings:
    - --workdir
    type: str
    default_random: true
    default_factory: random_identity
    name: workdir
  - help: The proxy when downloading sample data
    choices: null
    default: null
    required: false
    option_strings:
    - --download-proxy
    type: str
    default_random: false
    name: download_proxy
  - help: The number of shards when index and query
    choices: null
    default: 2
    required: false
    option_strings:
    - --shards
    type: int
    default_random: false
    name: shards
  - help: The number of parallel when index and query
    choices: null
    default: 2
    required: false
    option_strings:
    - --parallel
    type: int
    default_random: false
    name: parallel
  - help: The yaml path of the index flow
    choices: null
    default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.index.yml
    required: false
    option_strings:
    - --uses-index
    type: str
    default_random: false
    name: uses_index
  - help: The url of index data (should be in idx3-ubyte.gz format)
    choices: null
    default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz
    required: false
    option_strings:
    - --index-data-url
    type: str
    default_random: false
    name: index_data_url
  - help: The url of index labels data (should be in idx3-ubyte.gz format)
    choices: null
    default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz
    required: false
    option_strings:
    - --index-labels-url
    type: str
    default_random: false
    name: index_labels_url
  - help: The request size in indexing (the maximum number of documents that will
      be included in a Request before sending it)
    choices: null
    default: 1024
    required: false
    option_strings:
    - --index-request-size
    type: int
    default_random: false
    name: index_request_size
  - help: The yaml path of the query flow
    choices: null
    default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.query.yml
    required: false
    option_strings:
    - --uses-query
    type: str
    default_random: false
    name: uses_query
  - help: The url of query data (should be in idx3-ubyte.gz format)
    choices: null
    default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz
    required: false
    option_strings:
    - --query-data-url
    type: str
    default_random: false
    name: query_data_url
  - help: The url of query labels data (should be in idx3-ubyte.gz format)
    choices: null
    default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz
    required: false
    option_strings:
    - --query-labels-url
    type: str
    default_random: false
    name: query_labels_url
  - help: The request size in searching (the maximum number of documents that will
      be included in a Request before sending it)
    choices: null
    default: 32
    required: false
    option_strings:
    - --query-request-size
    type: int
    default_random: false
    name: query_request_size
  - help: The number of queries to visualize
    choices: null
    default: 128
    required: false
    option_strings:
    - --num-query
    type: int
    default_random: false
    name: num_query
  - help: Top-k results to retrieve and visualize
    choices: null
    default: 50
    required: false
    option_strings:
    - --top-k
    type: int
    default_random: false
    name: top_k
- name: pod
  options:
  - help: "\nThe name of this object.\n\nThis will be used in the following places:\n\
      - how you refer to this object in Python/YAML/CLI\n- log message\n- ...\n\n\
      When not given, then the default naming strategy will apply.\n             \
      \       "
    choices: null
    default: null
    required: false
    option_strings:
    - --name
    type: str
    default_random: false
    name: name
  - help: The YAML config of the logger used in this object.
    choices: null
    default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
    required: false
    option_strings:
    - --log-config
    type: str
    default_random: false
    name: log_config
  - help: If set, then exception stack information to be added to the logging message,
      useful in debugging
    choices: null
    default: false
    required: false
    option_strings:
    - --show-exc-info
    type: bool
    default_random: false
    name: show_exc_info
  - help: The port for controlling the runtime, default a random port between [49152,
      65535]
    choices: null
    default: 48069
    required: false
    option_strings:
    - --port-ctrl
    type: int
    default_random: true
    default_factory: random_port
    name: port_ctrl
  - help: If set, use ipc protocol for control socket
    choices: null
    default: false
    required: false
    option_strings:
    - --ctrl-with-ipc
    type: bool
    default_random: false
    name: ctrl_with_ipc
  - help: The timeout in milliseconds of the control request, -1 for waiting forever
    choices: null
    default: 5000
    required: false
    option_strings:
    - --timeout-ctrl
    type: int
    default_random: false
    name: timeout_ctrl
  - help: The SSH server through which the tunnel will be created, can actually be
      a fully specified "user@server:port" ssh url.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-server
    type: str
    default_random: false
    name: ssh_server
  - help: This specifies a key to be used in ssh login, default None. regular default
      ssh keys will be used without specifying this argument.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-keyfile
    type: str
    default_random: false
    name: ssh_keyfile
  - help: The ssh password to the ssh server.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-password
    type: str
    default_random: false
    name: ssh_password
  - help: "\nThe config of the executor, it could be one of the followings: \n- an\
      \ Executor-level YAML file path (*.yml/yaml) \n- a name of a class inherited\
      \ from \"jina.Executor\"\n- a docker image (must start with \"docker://\")\n\
      - builtin executors, e.g. \"_pass\", \"_logforward\", \"_merge\" \n- the string\
      \ literal of a YAML config (must start with \"!\")\n- the string literal of\
      \ a JSON config\n- the string literal of a YAML driver config (must start with\
      \ \"- !!\")\n\nWhen use it under Python, one can use the following values additionally:\n\
      - a Python dict that represents the config\n- a text file stream has `.read()`\
      \ interface\n"
    choices: null
    default: _pass
    required: false
    option_strings:
    - --uses
    type: str
    default_random: false
    name: uses
  - help: "\nThe customized python modules need to be imported before loading the\
      \ executor\n\nNote, when importing multiple files and there is a dependency\
      \ between them, then one has to write the dependencies in \nreverse order. That\
      \ is, if `__init__.py` depends on `A.py`, which again depends on `B.py`, then\
      \ you need to write: \n\n--py-modules __init__.py --py-modules B.py --py-modules\
      \ A.py\n\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --py-modules
    type: str
    default_random: false
    name: py_modules
  - help: The port for input data, default a random port between [49152, 65535]
    choices: null
    default: 33257
    required: false
    option_strings:
    - --port-in
    type: int
    default_random: true
    default_factory: random_port
    name: port_in
  - help: The port for output data, default a random port between [49152, 65535]
    choices: null
    default: 33953
    required: false
    option_strings:
    - --port-out
    type: int
    default_random: true
    default_factory: random_port
    name: port_out
  - help: The host address for input, by default it is 0.0.0.0
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host-in
    type: str
    default_random: false
    name: host_in
  - help: The host address for output, by default it is 0.0.0.0
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host-out
    type: str
    default_random: false
    name: host_out
  - help: The socket type for input port
    choices:
    - PULL_BIND
    - PULL_CONNECT
    - PUSH_BIND
    - PUSH_CONNECT
    - SUB_BIND
    - SUB_CONNECT
    - PUB_BIND
    - PUB_CONNECT
    - PAIR_BIND
    - PAIR_CONNECT
    - ROUTER_BIND
    - DEALER_CONNECT
    default: PULL_BIND
    required: false
    option_strings:
    - --socket-in
    type: str
    default_random: false
    name: socket_in
  - help: The socket type for output port
    choices:
    - PULL_BIND
    - PULL_CONNECT
    - PUSH_BIND
    - PUSH_CONNECT
    - SUB_BIND
    - SUB_CONNECT
    - PUB_BIND
    - PUB_CONNECT
    - PAIR_BIND
    - PAIR_CONNECT
    - ROUTER_BIND
    - DEALER_CONNECT
    default: PUSH_BIND
    required: false
    option_strings:
    - --socket-out
    type: str
    default_random: false
    name: socket_out
  - help: 'serialize the model in the pod every n seconds if model changes. -1 means
      --read-only. '
    choices: null
    default: 240
    required: false
    option_strings:
    - --dump-interval
    type: int
    default_random: false
    name: dump_interval
  - help: If set, do not allow the pod to modify the model, dump_interval will be
      ignored
    choices: null
    default: false
    required: false
    option_strings:
    - --read-only
    type: bool
    default_random: false
    name: read_only
  - help: the data and config files are separated for each pea in this pod, only effective
      when BasePod's `parallel` > 1
    choices: null
    default: false
    required: false
    option_strings:
    - --separated-workspace
    type: bool
    default_random: false
    name: separated_workspace
  - help: The memory high watermark of this pod in Gigabytes, pod will restart when
      this is reached. -1 means no restriction
    choices: null
    default: -1
    required: false
    option_strings:
    - --memory-hwm
    type: int
    default_random: false
    name: memory_hwm
  - help: The skip strategy on error message.
    choices:
    - NONE
    - EXECUTOR
    - HANDLE
    default: NONE
    required: false
    option_strings:
    - --skip-on-error
    type: str
    default_random: false
    name: skip_on_error
  - help: "\nThe config runs inside the Docker container. \n\nSyntax and function\
      \ are the same as `--uses`. This is designed when `--uses=\"docker://...\"`\
      \ this config is passed to \nthe Docker container.\n"
    choices: null
    default: BaseExecutor
    required: false
    option_strings:
    - --uses-internal
    type: str
    default_random: false
    name: uses_internal
  - help: The entrypoint command overrides the ENTRYPOINT in Docker image. when not
      set then the Docker image ENTRYPOINT takes effective.
    choices: null
    default: null
    required: false
    option_strings:
    - --entrypoint
    type: str
    default_random: false
    name: entrypoint
  - help: Pull the latest image before running
    choices: null
    default: false
    required: false
    option_strings:
    - --pull-latest
    type: bool
    default_random: false
    name: pull_latest
  - help: "\nThe path on the host to be mounted inside the container. \n\nNote, \n\
      - If separated by `:`, then the first part will be considered as the local host\
      \ path and the second part is the path in the container system. \n- If no split\
      \ provided, then the basename of that directory will be mounted into container's\
      \ root path, e.g. `--volumes=\"/user/test/my-workspace\"` will be mounted into\
      \ \"/my-workspace\" inside the container. \n- All volumes are mounted with read-write\
      \ mode.\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --volumes
    type: str
    default_random: false
    name: volumes
  - help: The host address of the runtime, by default it is 0.0.0.0.
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host
    type: str
    default_random: false
    name: host
  - help: The port of the host exposed to the public
    choices: null
    default: 46757
    required: false
    option_strings:
    - --port-expose
    type: int
    default_random: true
    default_factory: random_port
    name: port_expose
  - help: Do not display the streaming of remote logs on local console
    choices: null
    default: false
    required: false
    option_strings:
    - --silent-remote-logs
    type: bool
    default_random: false
    name: silent_remote_logs
  - help: "\nThe files on the host to be uploaded to the remote\nworkspace. This can\
      \ be useful when your Pod has more\nfile dependencies beyond a single YAML file,\
      \ e.g.\nPython files, data files. \n\nNote, \n- currently only flatten structure\
      \ is supported, which means if you upload `[./foo/a.py, ./foo/b.pp, ./bar/c.yml]`,\
      \ then they will be put under the _same_ workspace on the remote, losing all\
      \ hierarchies. \n- by default, `--uses` YAML file is always uploaded. \n- uploaded\
      \ files are by default isolated across the runs. To ensure files are submitted\
      \ to the same workspace across different runs, use `--workspace-id` to specify\
      \ the workspace.\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --upload-files
    type: str
    default_random: false
    name: upload_files
  - help: The UUID for identifying the workspace on remote. When not given then remote
      will assign a random one. Multiple Pea/Pod/Flow will work under the same workspace
      if they share the same `workspace-id`.
    choices: null
    default: null
    required: false
    option_strings:
    - --workspace-id
    type: str
    default_random: false
    name: workspace_id
  - help: The Pea attempts to terminate all of its Runtime child processes/threads
      on existing. setting it to true basically tell the Pea do not wait on the Runtime
      when closing
    choices: null
    default: false
    required: false
    option_strings:
    - --daemon
    type: bool
    default_random: false
    name: daemon
  - help: The parallel backend of the runtime inside the Pea
    choices:
    - THREAD
    - PROCESS
    default: PROCESS
    required: false
    option_strings:
    - --runtime-backend
    - --runtime
    type: str
    default_random: false
    name: runtime_backend
  - help: The runtime class to run inside the Pea
    choices:
    - GRPCRuntime
    - RESTRuntime
    - ContainerRuntime
    - JinadRuntime
    - SSHRuntime
    - ZEDRuntime
    default: ZEDRuntime
    required: false
    option_strings:
    - --runtime-cls
    type: str
    default_random: false
    name: runtime_cls
  - help: The timeout in milliseconds of a Pea waits for the runtime to be ready,
      -1 for waiting forever
    choices: null
    default: 10000
    required: false
    option_strings:
    - --timeout-ready
    type: int
    default_random: false
    name: timeout_ready
  - help: If set, expose the public IP address to remote when necessary, by default
      it exposesprivate IP address, which only allows accessing under the same network/subnet
    choices: null
    default: false
    required: false
    option_strings:
    - --expose-public
    type: bool
    default_random: false
    name: expose_public
  - help: The executor attached after the Peas described by --uses, typically before
      sending to all parallels, accepted type follows "--uses"
    choices: null
    default: null
    required: false
    option_strings:
    - --uses-before
    type: str
    default_random: false
    name: uses_before
  - help: The executor attached after the Peas described by --uses, typically used
      for receiving from all parallels, accepted type follows "--uses"
    choices: null
    default: null
    required: false
    option_strings:
    - --uses-after
    type: str
    default_random: false
    name: uses_after
  - help: If set, disable `uses-before` or `uses-after` if parallel is equal to 1.
      Useful to parametrize parallelization and sharding without having `uses_after`
      or `uses_before` taking extra processes and network hops
    choices: null
    default: false
    required: false
    option_strings:
    - --remove-uses-ba
    type: bool
    default_random: false
    name: remove_uses_ba
  - help: The number of parallel peas in the pod running at the same time, `port_in`
      and `port_out` will be set to random, and routers will be added automatically
      when necessary
    choices: null
    default: 1
    required: false
    option_strings:
    - --parallel
    - --shards
    type: int
    default_random: false
    name: parallel
  - help: "\nThe polling strategy of the Pod (when `parallel>1`) \n- ANY: only one\
      \ (whoever is idle) Pea polls the message\n- ALL: all Peas poll the message\
      \ (like a broadcast)\n"
    choices:
    - ANY
    - ALL
    - ALL_ASYNC
    default: ANY
    required: false
    option_strings:
    - --polling
    type: str
    default_random: false
    name: polling
  - help: The strategy of scheduling workload among Peas
    choices:
    - LOAD_BALANCE
    - ROUND_ROBIN
    default: LOAD_BALANCE
    required: false
    option_strings:
    - --scheduling
    type: str
    default_random: false
    name: scheduling
- name: flow
  options:
  - help: "\nThe name of this object.\n\nThis will be used in the following places:\n\
      - how you refer to this object in Python/YAML/CLI\n- log message\n- ...\n\n\
      When not given, then the default naming strategy will apply.\n             \
      \       "
    choices: null
    default: null
    required: false
    option_strings:
    - --name
    type: str
    default_random: false
    name: name
  - help: The YAML config of the logger used in this object.
    choices: null
    default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
    required: false
    option_strings:
    - --log-config
    type: str
    default_random: false
    name: log_config
  - help: If set, then exception stack information to be added to the logging message,
      useful in debugging
    choices: null
    default: false
    required: false
    option_strings:
    - --show-exc-info
    type: bool
    default_random: false
    name: show_exc_info
  - help: The YAML file represents a flow
    choices: null
    default: null
    required: false
    option_strings:
    - --uses
    type: str
    default_random: false
    name: uses
  - help: '

      The strategy on those inspect pods in the flow.


      If `REMOVE` is given then all inspect pods are removed when building the flow.

      '
    choices:
    - HANG
    - REMOVE
    - COLLECT
    default: COLLECT
    required: false
    option_strings:
    - --inspect
    type: str
    default_random: false
    name: inspect
- name: gateway
  options:
  - help: "\nThe name of this object.\n\nThis will be used in the following places:\n\
      - how you refer to this object in Python/YAML/CLI\n- log message\n- ...\n\n\
      When not given, then the default naming strategy will apply.\n             \
      \       "
    choices: null
    default: gateway
    required: false
    option_strings:
    - --name
    type: str
    default_random: false
    name: name
  - help: The YAML config of the logger used in this object.
    choices: null
    default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
    required: false
    option_strings:
    - --log-config
    type: str
    default_random: false
    name: log_config
  - help: If set, then exception stack information to be added to the logging message,
      useful in debugging
    choices: null
    default: false
    required: false
    option_strings:
    - --show-exc-info
    type: bool
    default_random: false
    name: show_exc_info
  - help: The port for controlling the runtime, default a random port between [49152,
      65535]
    choices: null
    default: 35043
    required: false
    option_strings:
    - --port-ctrl
    type: int
    default_random: true
    default_factory: random_port
    name: port_ctrl
  - help: If set, use ipc protocol for control socket
    choices: null
    default: true
    required: false
    option_strings:
    - --ctrl-with-ipc
    type: bool
    default_random: false
    name: ctrl_with_ipc
  - help: The timeout in milliseconds of the control request, -1 for waiting forever
    choices: null
    default: 5000
    required: false
    option_strings:
    - --timeout-ctrl
    type: int
    default_random: false
    name: timeout_ctrl
  - help: The SSH server through which the tunnel will be created, can actually be
      a fully specified "user@server:port" ssh url.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-server
    type: str
    default_random: false
    name: ssh_server
  - help: This specifies a key to be used in ssh login, default None. regular default
      ssh keys will be used without specifying this argument.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-keyfile
    type: str
    default_random: false
    name: ssh_keyfile
  - help: The ssh password to the ssh server.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-password
    type: str
    default_random: false
    name: ssh_password
  - help: "\nThe config of the executor, it could be one of the followings: \n- an\
      \ Executor-level YAML file path (*.yml/yaml) \n- a name of a class inherited\
      \ from \"jina.Executor\"\n- a docker image (must start with \"docker://\")\n\
      - builtin executors, e.g. \"_pass\", \"_logforward\", \"_merge\" \n- the string\
      \ literal of a YAML config (must start with \"!\")\n- the string literal of\
      \ a JSON config\n- the string literal of a YAML driver config (must start with\
      \ \"- !!\")\n\nWhen use it under Python, one can use the following values additionally:\n\
      - a Python dict that represents the config\n- a text file stream has `.read()`\
      \ interface\n"
    choices: null
    default: _pass
    required: false
    option_strings:
    - --uses
    type: str
    default_random: false
    name: uses
  - help: "\nThe customized python modules need to be imported before loading the\
      \ executor\n\nNote, when importing multiple files and there is a dependency\
      \ between them, then one has to write the dependencies in \nreverse order. That\
      \ is, if `__init__.py` depends on `A.py`, which again depends on `B.py`, then\
      \ you need to write: \n\n--py-modules __init__.py --py-modules B.py --py-modules\
      \ A.py\n\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --py-modules
    type: str
    default_random: false
    name: py_modules
  - help: The port for input data, default a random port between [49152, 65535]
    choices: null
    default: 46287
    required: false
    option_strings:
    - --port-in
    type: int
    default_random: true
    default_factory: random_port
    name: port_in
  - help: The port for output data, default a random port between [49152, 65535]
    choices: null
    default: 40505
    required: false
    option_strings:
    - --port-out
    type: int
    default_random: true
    default_factory: random_port
    name: port_out
  - help: The host address for input, by default it is 0.0.0.0
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host-in
    type: str
    default_random: false
    name: host_in
  - help: The host address for output, by default it is 0.0.0.0
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host-out
    type: str
    default_random: false
    name: host_out
  - help: The socket type for input port
    choices:
    - PULL_BIND
    - PULL_CONNECT
    - PUSH_BIND
    - PUSH_CONNECT
    - SUB_BIND
    - SUB_CONNECT
    - PUB_BIND
    - PUB_CONNECT
    - PAIR_BIND
    - PAIR_CONNECT
    - ROUTER_BIND
    - DEALER_CONNECT
    default: PULL_CONNECT
    required: false
    option_strings:
    - --socket-in
    type: str
    default_random: false
    name: socket_in
  - help: The socket type for output port
    choices:
    - PULL_BIND
    - PULL_CONNECT
    - PUSH_BIND
    - PUSH_CONNECT
    - SUB_BIND
    - SUB_CONNECT
    - PUB_BIND
    - PUB_CONNECT
    - PAIR_BIND
    - PAIR_CONNECT
    - ROUTER_BIND
    - DEALER_CONNECT
    default: PUSH_CONNECT
    required: false
    option_strings:
    - --socket-out
    type: str
    default_random: false
    name: socket_out
  - help: 'serialize the model in the pod every n seconds if model changes. -1 means
      --read-only. '
    choices: null
    default: 240
    required: false
    option_strings:
    - --dump-interval
    type: int
    default_random: false
    name: dump_interval
  - help: If set, do not allow the pod to modify the model, dump_interval will be
      ignored
    choices: null
    default: true
    required: false
    option_strings:
    - --read-only
    type: bool
    default_random: false
    name: read_only
  - help: the data and config files are separated for each pea in this pod, only effective
      when BasePod's `parallel` > 1
    choices: null
    default: false
    required: false
    option_strings:
    - --separated-workspace
    type: bool
    default_random: false
    name: separated_workspace
  - help: The memory high watermark of this pod in Gigabytes, pod will restart when
      this is reached. -1 means no restriction
    choices: null
    default: -1
    required: false
    option_strings:
    - --memory-hwm
    type: int
    default_random: false
    name: memory_hwm
  - help: The skip strategy on error message.
    choices:
    - NONE
    - EXECUTOR
    - HANDLE
    default: NONE
    required: false
    option_strings:
    - --skip-on-error
    type: str
    default_random: false
    name: skip_on_error
  - help: The maximum send and receive size for gRPC server in bytes, -1 means unlimited
    choices: null
    default: -1
    required: false
    option_strings:
    - --max-message-size
    type: int
    default_random: false
    name: max_message_size
  - help: If set, respect the http_proxy and https_proxy environment variables. otherwise,
      it will unset these proxy variables before start. gRPC seems to prefer no proxy
    choices: null
    default: false
    required: false
    option_strings:
    - --proxy
    type: bool
    default_random: false
    name: proxy
  - help: The number of pre-fetched requests from the client
    choices: null
    default: 50
    required: false
    option_strings:
    - --prefetch
    type: int
    default_random: false
    name: prefetch
  - help: The number of additional requests to fetch on every receive
    choices: null
    default: 1
    required: false
    option_strings:
    - --prefetch-on-recv
    type: int
    default_random: false
    name: prefetch_on_recv
  - help: If set, use RESTful interface instead of gRPC as the main interface
    choices: null
    default: false
    required: false
    option_strings:
    - --restful
    - --rest-api
    type: bool
    default_random: false
    name: restful
  - help: The host address of the runtime, by default it is 0.0.0.0.
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host
    type: str
    default_random: false
    name: host
  - help: The port of the host exposed to the public
    choices: null
    default: 51081
    required: false
    option_strings:
    - --port-expose
    type: int
    default_random: true
    default_factory: random_port
    name: port_expose
  - help: The Pea attempts to terminate all of its Runtime child processes/threads
      on existing. setting it to true basically tell the Pea do not wait on the Runtime
      when closing
    choices: null
    default: false
    required: false
    option_strings:
    - --daemon
    type: bool
    default_random: false
    name: daemon
  - help: The parallel backend of the runtime inside the Pea
    choices:
    - THREAD
    - PROCESS
    default: PROCESS
    required: false
    option_strings:
    - --runtime-backend
    - --runtime
    type: str
    default_random: false
    name: runtime_backend
  - help: The runtime class to run inside the Pea
    choices:
    - GRPCRuntime
    - RESTRuntime
    - ContainerRuntime
    - JinadRuntime
    - SSHRuntime
    - ZEDRuntime
    default: GRPCRuntime
    required: false
    option_strings:
    - --runtime-cls
    type: str
    default_random: false
    name: runtime_cls
  - help: The timeout in milliseconds of a Pea waits for the runtime to be ready,
      -1 for waiting forever
    choices: null
    default: 10000
    required: false
    option_strings:
    - --timeout-ready
    type: int
    default_random: false
    name: timeout_ready
  - help: If set, expose the public IP address to remote when necessary, by default
      it exposesprivate IP address, which only allows accessing under the same network/subnet
    choices: null
    default: false
    required: false
    option_strings:
    - --expose-public
    type: bool
    default_random: false
    name: expose_public
- name: ping
  options:
  - help: The host address of the target Pea, e.g. 0.0.0.0
    choices: null
    default: null
    required: true
    option_strings: []
    type: str
    default_random: false
    name: host
  - help: The control port of the target pod/pea
    choices: null
    default: null
    required: true
    option_strings: []
    type: int
    default_random: false
    name: port
  - help: '

      Timeout in millisecond of one check

      -1 for waiting forever

      '
    choices: null
    default: 3000
    required: false
    option_strings:
    - --timeout
    type: int
    default_random: false
    name: timeout
  - help: The max number of tried health checks before exit with exit code 1
    choices: null
    default: 3
    required: false
    option_strings:
    - --retries
    type: int
    default_random: false
    name: retries
  - help: If set, print the response when received
    choices: null
    default: false
    required: false
    option_strings:
    - --print-response
    type: bool
    default_random: false
    name: print_response
- name: check
  options:
  - help: The markdown file path for all executors summary
    choices: null
    default: null
    required: false
    option_strings:
    - --summary-exec
    type: str
    default_random: false
    name: summary_exec
  - help: The markdown file path for all drivers summary
    choices: null
    default: null
    required: false
    option_strings:
    - --summary-driver
    type: str
    default_random: false
    name: summary_driver
- name: hub
  options: []
- name: pea
  options:
  - help: "\nThe name of this object.\n\nThis will be used in the following places:\n\
      - how you refer to this object in Python/YAML/CLI\n- log message\n- ...\n\n\
      When not given, then the default naming strategy will apply.\n             \
      \       "
    choices: null
    default: null
    required: false
    option_strings:
    - --name
    type: str
    default_random: false
    name: name
  - help: The YAML config of the logger used in this object.
    choices: null
    default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
    required: false
    option_strings:
    - --log-config
    type: str
    default_random: false
    name: log_config
  - help: If set, then exception stack information to be added to the logging message,
      useful in debugging
    choices: null
    default: false
    required: false
    option_strings:
    - --show-exc-info
    type: bool
    default_random: false
    name: show_exc_info
  - help: The port for controlling the runtime, default a random port between [49152,
      65535]
    choices: null
    default: 57987
    required: false
    option_strings:
    - --port-ctrl
    type: int
    default_random: true
    default_factory: random_port
    name: port_ctrl
  - help: If set, use ipc protocol for control socket
    choices: null
    default: false
    required: false
    option_strings:
    - --ctrl-with-ipc
    type: bool
    default_random: false
    name: ctrl_with_ipc
  - help: The timeout in milliseconds of the control request, -1 for waiting forever
    choices: null
    default: 5000
    required: false
    option_strings:
    - --timeout-ctrl
    type: int
    default_random: false
    name: timeout_ctrl
  - help: The SSH server through which the tunnel will be created, can actually be
      a fully specified "user@server:port" ssh url.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-server
    type: str
    default_random: false
    name: ssh_server
  - help: This specifies a key to be used in ssh login, default None. regular default
      ssh keys will be used without specifying this argument.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-keyfile
    type: str
    default_random: false
    name: ssh_keyfile
  - help: The ssh password to the ssh server.
    choices: null
    default: null
    required: false
    option_strings:
    - --ssh-password
    type: str
    default_random: false
    name: ssh_password
  - help: "\nThe config of the executor, it could be one of the followings: \n- an\
      \ Executor-level YAML file path (*.yml/yaml) \n- a name of a class inherited\
      \ from \"jina.Executor\"\n- a docker image (must start with \"docker://\")\n\
      - builtin executors, e.g. \"_pass\", \"_logforward\", \"_merge\" \n- the string\
      \ literal of a YAML config (must start with \"!\")\n- the string literal of\
      \ a JSON config\n- the string literal of a YAML driver config (must start with\
      \ \"- !!\")\n\nWhen use it under Python, one can use the following values additionally:\n\
      - a Python dict that represents the config\n- a text file stream has `.read()`\
      \ interface\n"
    choices: null
    default: _pass
    required: false
    option_strings:
    - --uses
    type: str
    default_random: false
    name: uses
  - help: "\nThe customized python modules need to be imported before loading the\
      \ executor\n\nNote, when importing multiple files and there is a dependency\
      \ between them, then one has to write the dependencies in \nreverse order. That\
      \ is, if `__init__.py` depends on `A.py`, which again depends on `B.py`, then\
      \ you need to write: \n\n--py-modules __init__.py --py-modules B.py --py-modules\
      \ A.py\n\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --py-modules
    type: str
    default_random: false
    name: py_modules
  - help: The port for input data, default a random port between [49152, 65535]
    choices: null
    default: 57517
    required: false
    option_strings:
    - --port-in
    type: int
    default_random: true
    default_factory: random_port
    name: port_in
  - help: The port for output data, default a random port between [49152, 65535]
    choices: null
    default: 50563
    required: false
    option_strings:
    - --port-out
    type: int
    default_random: true
    default_factory: random_port
    name: port_out
  - help: The host address for input, by default it is 0.0.0.0
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host-in
    type: str
    default_random: false
    name: host_in
  - help: The host address for output, by default it is 0.0.0.0
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host-out
    type: str
    default_random: false
    name: host_out
  - help: The socket type for input port
    choices:
    - PULL_BIND
    - PULL_CONNECT
    - PUSH_BIND
    - PUSH_CONNECT
    - SUB_BIND
    - SUB_CONNECT
    - PUB_BIND
    - PUB_CONNECT
    - PAIR_BIND
    - PAIR_CONNECT
    - ROUTER_BIND
    - DEALER_CONNECT
    default: PULL_BIND
    required: false
    option_strings:
    - --socket-in
    type: str
    default_random: false
    name: socket_in
  - help: The socket type for output port
    choices:
    - PULL_BIND
    - PULL_CONNECT
    - PUSH_BIND
    - PUSH_CONNECT
    - SUB_BIND
    - SUB_CONNECT
    - PUB_BIND
    - PUB_CONNECT
    - PAIR_BIND
    - PAIR_CONNECT
    - ROUTER_BIND
    - DEALER_CONNECT
    default: PUSH_BIND
    required: false
    option_strings:
    - --socket-out
    type: str
    default_random: false
    name: socket_out
  - help: 'serialize the model in the pod every n seconds if model changes. -1 means
      --read-only. '
    choices: null
    default: 240
    required: false
    option_strings:
    - --dump-interval
    type: int
    default_random: false
    name: dump_interval
  - help: If set, do not allow the pod to modify the model, dump_interval will be
      ignored
    choices: null
    default: false
    required: false
    option_strings:
    - --read-only
    type: bool
    default_random: false
    name: read_only
  - help: the data and config files are separated for each pea in this pod, only effective
      when BasePod's `parallel` > 1
    choices: null
    default: false
    required: false
    option_strings:
    - --separated-workspace
    type: bool
    default_random: false
    name: separated_workspace
  - help: The memory high watermark of this pod in Gigabytes, pod will restart when
      this is reached. -1 means no restriction
    choices: null
    default: -1
    required: false
    option_strings:
    - --memory-hwm
    type: int
    default_random: false
    name: memory_hwm
  - help: The skip strategy on error message.
    choices:
    - NONE
    - EXECUTOR
    - HANDLE
    default: NONE
    required: false
    option_strings:
    - --skip-on-error
    type: str
    default_random: false
    name: skip_on_error
  - help: "\nThe config runs inside the Docker container. \n\nSyntax and function\
      \ are the same as `--uses`. This is designed when `--uses=\"docker://...\"`\
      \ this config is passed to \nthe Docker container.\n"
    choices: null
    default: BaseExecutor
    required: false
    option_strings:
    - --uses-internal
    type: str
    default_random: false
    name: uses_internal
  - help: The entrypoint command overrides the ENTRYPOINT in Docker image. when not
      set then the Docker image ENTRYPOINT takes effective.
    choices: null
    default: null
    required: false
    option_strings:
    - --entrypoint
    type: str
    default_random: false
    name: entrypoint
  - help: Pull the latest image before running
    choices: null
    default: false
    required: false
    option_strings:
    - --pull-latest
    type: bool
    default_random: false
    name: pull_latest
  - help: "\nThe path on the host to be mounted inside the container. \n\nNote, \n\
      - If separated by `:`, then the first part will be considered as the local host\
      \ path and the second part is the path in the container system. \n- If no split\
      \ provided, then the basename of that directory will be mounted into container's\
      \ root path, e.g. `--volumes=\"/user/test/my-workspace\"` will be mounted into\
      \ \"/my-workspace\" inside the container. \n- All volumes are mounted with read-write\
      \ mode.\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --volumes
    type: str
    default_random: false
    name: volumes
  - help: The host address of the runtime, by default it is 0.0.0.0.
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host
    type: str
    default_random: false
    name: host
  - help: The port of the host exposed to the public
    choices: null
    default: 45073
    required: false
    option_strings:
    - --port-expose
    type: int
    default_random: true
    default_factory: random_port
    name: port_expose
  - help: Do not display the streaming of remote logs on local console
    choices: null
    default: false
    required: false
    option_strings:
    - --silent-remote-logs
    type: bool
    default_random: false
    name: silent_remote_logs
  - help: "\nThe files on the host to be uploaded to the remote\nworkspace. This can\
      \ be useful when your Pod has more\nfile dependencies beyond a single YAML file,\
      \ e.g.\nPython files, data files. \n\nNote, \n- currently only flatten structure\
      \ is supported, which means if you upload `[./foo/a.py, ./foo/b.pp, ./bar/c.yml]`,\
      \ then they will be put under the _same_ workspace on the remote, losing all\
      \ hierarchies. \n- by default, `--uses` YAML file is always uploaded. \n- uploaded\
      \ files are by default isolated across the runs. To ensure files are submitted\
      \ to the same workspace across different runs, use `--workspace-id` to specify\
      \ the workspace.\n"
    choices: null
    default: null
    required: false
    option_strings:
    - --upload-files
    type: str
    default_random: false
    name: upload_files
  - help: The UUID for identifying the workspace on remote. When not given then remote
      will assign a random one. Multiple Pea/Pod/Flow will work under the same workspace
      if they share the same `workspace-id`.
    choices: null
    default: null
    required: false
    option_strings:
    - --workspace-id
    type: str
    default_random: false
    name: workspace_id
  - help: The Pea attempts to terminate all of its Runtime child processes/threads
      on existing. setting it to true basically tell the Pea do not wait on the Runtime
      when closing
    choices: null
    default: false
    required: false
    option_strings:
    - --daemon
    type: bool
    default_random: false
    name: daemon
  - help: The parallel backend of the runtime inside the Pea
    choices:
    - THREAD
    - PROCESS
    default: PROCESS
    required: false
    option_strings:
    - --runtime-backend
    - --runtime
    type: str
    default_random: false
    name: runtime_backend
  - help: The runtime class to run inside the Pea
    choices:
    - GRPCRuntime
    - RESTRuntime
    - ContainerRuntime
    - JinadRuntime
    - SSHRuntime
    - ZEDRuntime
    default: ZEDRuntime
    required: false
    option_strings:
    - --runtime-cls
    type: str
    default_random: false
    name: runtime_cls
  - help: The timeout in milliseconds of a Pea waits for the runtime to be ready,
      -1 for waiting forever
    choices: null
    default: 10000
    required: false
    option_strings:
    - --timeout-ready
    type: int
    default_random: false
    name: timeout_ready
  - help: If set, expose the public IP address to remote when necessary, by default
      it exposesprivate IP address, which only allows accessing under the same network/subnet
    choices: null
    default: false
    required: false
    option_strings:
    - --expose-public
    type: bool
    default_random: false
    name: expose_public
- name: log
  options:
  - help: The regular expression for grouping logs
    choices: null
    default: (.*@\d+)\[
    required: false
    option_strings:
    - --groupby-regex
    type: str
    default_random: false
    name: groupby_regex
  - help: The refresh time interval in seconds, set to -1 to persist all grouped logs
    choices: null
    default: 5
    required: false
    option_strings:
    - --refresh-time
    type: int
    default_random: false
    name: refresh_time
- name: client
  options:
  - help: The number of Documents in each Request.
    choices: null
    default: 100
    required: false
    option_strings:
    - --request-size
    type: int
    default_random: false
    name: request_size
  - help: "\nThe Request mode. This applies to all Requests sent from this client.\n\
      \n* INDEX: store new Documents into the system\n* SEARCH: query Documents from\
      \ an indexed system\n* UPDATE: update existing Documents in an indexed system\n\
      * DELETE: delete existing Documents from an indexed system\n* CONTROL: (advance)\
      \ control Pea/Pod such as shutdown, status\n* TRAIN: (experimental) train the\
      \ system\n                    "
    choices:
    - INDEX
    - SEARCH
    - DELETE
    - UPDATE
    - CONTROL
    - TRAIN
    default: null
    required: false
    option_strings:
    - --mode
    type: str
    default_random: false
    name: mode
  - help: The number of results will be returned. Sorted by their scores descendingly.
    choices: null
    default: null
    required: false
    option_strings:
    - --top-k
    type: int
    default_random: false
    name: top_k
  - help: MIME type of the input Documents.
    choices: null
    default: null
    required: false
    option_strings:
    - --mime-type
    type: str
    default_random: false
    name: mime_type
  - help: If set, a Request that causes error will be logged only without blocking
      the further requests.
    choices: null
    default: false
    required: false
    option_strings:
    - --continue-on-error
    type: bool
    default_random: false
    name: continue_on_error
  - help: "\nThis feature is only used for AsyncClient.\n\nIf set, the results of\
      \ all Requests will be returned as a list. This is useful when one wants \n\
      process Responses in bulk instead of using callback. \n                    "
    choices: null
    default: false
    required: false
    option_strings:
    - --return-results
    type: bool
    default_random: false
    name: return_results
  - help: The maximum send and receive size for gRPC server in bytes, -1 means unlimited
    choices: null
    default: -1
    required: false
    option_strings:
    - --max-message-size
    type: int
    default_random: false
    name: max_message_size
  - help: If set, respect the http_proxy and https_proxy environment variables. otherwise,
      it will unset these proxy variables before start. gRPC seems to prefer no proxy
    choices: null
    default: false
    required: false
    option_strings:
    - --proxy
    type: bool
    default_random: false
    name: proxy
  - help: The number of pre-fetched requests from the client
    choices: null
    default: 50
    required: false
    option_strings:
    - --prefetch
    type: int
    default_random: false
    name: prefetch
  - help: The number of additional requests to fetch on every receive
    choices: null
    default: 1
    required: false
    option_strings:
    - --prefetch-on-recv
    type: int
    default_random: false
    name: prefetch_on_recv
  - help: If set, use RESTful interface instead of gRPC as the main interface
    choices: null
    default: false
    required: false
    option_strings:
    - --restful
    - --rest-api
    type: bool
    default_random: false
    name: restful
  - help: The host address of the runtime, by default it is 0.0.0.0.
    choices: null
    default: 0.0.0.0
    required: false
    option_strings:
    - --host
    type: str
    default_random: false
    name: host
  - help: The port of the host exposed to the public
    choices: null
    default: 38855
    required: false
    option_strings:
    - --port-expose
    type: int
    default_random: true
    default_factory: random_port
    name: port_expose
- name: export-api
  options:
  - help: The YAML file path for storing the exported API
    choices: null
    default: null
    required: false
    option_strings:
    - --yaml-path
    type: str
    default_random: false
    name: yaml_path
  - help: The JSON file path for storing the exported API
    choices: null
    default: null
    required: false
    option_strings:
    - --json-path
    type: str
    default_random: false
    name: json_path
revision: null