aiq.runtime.user_metadata

Classes

RequestAttributes

The RequestAttributes class is responsible for managing user-defined

Module Contents

class RequestAttributes

The RequestAttributes class is responsible for managing user-defined metadata and attributes. It provides a way to store and expose user-defined attributes to workflow tools.

_request: aiq.data_models.api_server.Request

property method: str | None

This property retrieves the HTTP method of the request. It can be GET, POST, PUT, DELETE, etc.

Returns:

str | None

property url_path: str | None

This property retrieves the path from the URL of the request.

Returns:

str | None

property url_port: int | None

This property retrieves the port number from the URL of the request.

Returns:

int | None

property url_scheme: str | None

This property retrieves the scheme from the URL of the request.

Returns:

str | None

property headers: starlette.datastructures.Headers | None

This property retrieves the headers from the request stored in a dictionary-like object.

Returns:

Headers | None

property query_params: starlette.datastructures.QueryParams | None

This property retrieves the query parameters from the request stored in a dictionary-like object.

Returns:

QueryParams | None

property path_params: dict[str, str] | None

This property retrieves the path parameters from the request stored in a dictionary-like object.

Returns:

dict[str, str] | None

property client_host: str | None

This property retrieves the clients remote hostname or IP address.

Returns:

str | None

property client_port: int | None

This property retrieves the clients remote port number from which the client is connecting to.

Returns:

int | None

property cookies: dict[str, str] | None

This property retrieves the cookies from the request stored in a dictionary-like object.

Returns:

dict[str, str] | None