Skip to content

Client

Description

The Client enables usage of the JellyFaaS function library.

Most methods are dependant on the Client instance's internal state and must only be called in increasing order of "call sequence" (see below). Additionally, some methods are marked as "required". These methods must be called to invoke a minimal JellyFaaS function.

For example, neither set_function_body() nor set_function_query_params() may be called before:

  1. Client()
  2. set_version() (optionally)
  3. lookup_function()

Methods

Return Method Call Sequence
Client Client(config: Config)
1(Required)
Client set_version(version: int) 2
Client lookup_function(function_id: str)
3(Required)
Client set_function_body(query_params: Dict[str, str]) 4
Client set_function_query_params(query_params: dict) 4
Client invoke(query_params: dict)
5(Required)
Client get_status_code(query_params: dict) 6

Method Descriptions

Client(config: Config) -> Client

Raises JellyFaasException

Client constructor. The client saves a reference to config, which contains your Secret key, handles authentication, and miscellaneous configuration. If config is invalid, raises JellyFaasException

set_version(version: int) -> Client

Raises JellyFaasException

Sets the version to be used by any following calls to lookup_function(). This state is cleared upon any call to clear(). version must be a positive (non-zero) integer. If version is invalid, raises JellyFaasException.

Note

If set_version() is not called, lookup_function() will default to the newest version. This means your code may break on future releases of any used functions. It is highly recommended to explicitly set_verion() first, to avoid this.

lookup_function(function_id: str) -> Client

Raises JellyFaasException

Requests the details of the JellyFaaS function with ID specified by function_id and optionally version specified by set_version(). If version is not specified, defaults to the newest version.

If successful, sets the function as the Client's active function. This will also clear any data set by set_function_body() or set_function_query_params().

If unsuccessful, raises JellyFaasException. This may be due to an invalid function_id or version.

set_function_body(body, do_validation: bool = True) -> Client

Raises JellyFaasException

set_function_body is used to pass data to a JellyFaaS function. Specifically, it is used to set the invocation's underlying HTTP request body.

Depending on the function's defined input, set_function_body will expect and validate against different types of data:

a. JSON

set_function_body expects body to be a dict or JSON-serializable class instance (extending from Pydantic BaseModel)

b. FILE

set_function_body expects body to be a bytes object.

By default, set_function_body will validate your input matches the function schema, ensuring your request is expected to succeed before actually invoking the function. The behaviour can be disabled by setting do_validation = False

set_function_query_params(query_params: Dict[str, str], do_validation = True) -> Client

Raises JellyFaasException

set_function_query_params is used to pass data to a JellyFaaS function. Specifically, it is used to set the invocation's underlying HTTP request query parameters. set_function_query_params expects body to be a flat dict of str keys and values.

By default, set_function_query_params will validate your input matches the function schema, ensuring your request is expected to succeed before actually invoking the function. The behavior can be disabled by setting do_validation = False

invoke(outputClass: Type = None) -> (Client, response)

Raises JellyFaasException

Calls the JellyFaaS function, with any inputs set by set_function_body and set_function_query_params. If an outputType is passed, invoke will attempt to cast the response to a new instance of the specified class.

get_status_code() -> Client

Raises JellyFaasException

Returns the HTTP status code returned with the last call of invoke()