Class KeepClient

Initialize a new KeepClient.

Arguments:
:api_client:
  The API client to use to find Keep services.  If not
  provided, KeepClient will build one from available Arvados
  configuration.

:proxy:
  If specified, this KeepClient will send requests to this Keep
  proxy.  Otherwise, KeepClient will fall back to the setting of the
  ARVADOS_KEEP_SERVICES or ARVADOS_KEEP_PROXY configuration settings.
  If you want to KeepClient does not use a proxy, pass in an empty
  string.

:timeout:
  The initial timeout (in seconds) for HTTP requests to Keep
  non-proxy servers.  A tuple of three floats is interpreted as
  (connection_timeout, read_timeout, minimum_bandwidth). A connection
  will be aborted if the average traffic rate falls below
  minimum_bandwidth bytes per second over an interval of read_timeout
  seconds. Because timeouts are often a result of transient server
  load, the actual connection timeout will be increased by a factor
  of two on each retry.
  Default: (2, 256, 32768).

:proxy_timeout:
  The initial timeout (in seconds) for HTTP requests to
  Keep proxies. A tuple of three floats is interpreted as
  (connection_timeout, read_timeout, minimum_bandwidth). The behavior
  described above for adjusting connection timeouts on retry also
  applies.
  Default: (20, 256, 32768).

:api_token:
  If you're not using an API client, but only talking
  directly to a Keep proxy, this parameter specifies an API token
  to authenticate Keep requests.  It is an error to specify both
  api_client and api_token.  If you specify neither, KeepClient
  will use one available from the Arvados configuration.

:local_store:
  If specified, this KeepClient will bypass Keep
  services, and save data to the named directory.  If unspecified,
  KeepClient will fall back to the setting of the $KEEP_LOCAL_STORE
  environment variable.  If you want to ensure KeepClient does not
  use local storage, pass in an empty string.  This is primarily
  intended to mock a server for testing.

:num_retries:
  The default number of times to retry failed requests.
  This will be used as the default num_retries value when get() and
  put() are called.  Default 0.

Return the appropriate timeout to use for this client.

The proxy timeout setting if the backend service is currently a proxy, the regular timeout setting otherwise. The `attempt_number` indicates how many times the operation has been tried already (starting from 0 for the first try), and scales the connection timeout portion of the return value accordingly.

Decorators:

• @retry.retry_method

Decorators:

• @retry.retry_method

Save data in Keep.

This method will get a list of Keep services from the API server, and
send the data to each one simultaneously in a new thread.  Once the
uploads are finished, if enough copies are saved, this method returns
the most recent HTTP response body.  If requests fail to upload
enough copies, this method raises KeepWriteError.

Arguments:
* data: The string of data to upload.
* copies: The number of copies that the user requires be saved.
  Default 2.
* num_retries: The number of times to retry PUT requests to
  *each* Keep server if it returns temporary failures, with
  exponential backoff.  The default value is set when the
  KeepClient is initialized.

Decorators:

• @retry.retry_method

A stub for put().

This method is used in place of the real put() method when using local storage (see constructor's local_store argument).

copies and num_retries arguments are ignored: they are here only for the sake of offering the same call signature as put().

Data stored this way can be retrieved via local_store_get().