loadero_python.resources.file module

Loadero file resource.

File resource is seperated into three parts

FileParams class describes file attributes

FileAPI class groups file related API calls

File class combines FileParams and FileAPI

Single File object coresponds to single file in Loadero.

class loadero_python.resources.file.File(file_id: int | None = None, params: FileParams | None = None)

Bases: LoaderoResource

File allows to perform CRUD manipulatons on a single Loadero file resource.

APIClient must be previously initialized with a valid Loadero access token.

The target Loadero file resource is determined by FileParams.

create() → File

Creates a new file.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• content

• file_type

Raises:

APIException: If API call fails.

Returns:

File: Created file resource.

delete() → None

Delete an existing file.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• file_id

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

read() → File

Reads information about an existing file.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• file_id

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

Returns:

File: Read file resource.

update() → File

Update information about an existing file.

Required attributes of params field that need to be populated, otherwise the method will raise an exception:

• file_id

• content

• file_type

Raises:

ValueError: If resource params do not sufficiently identify resource.

APIException: If API call fails.

Returns:

File: Updated file resource.

class loadero_python.resources.file.FileAPI

Bases: object

FileAPI defines Loadero API operations for file resources.

static create(params: FileParams) → FileParams

Create a new file resource.

Args:

params (FileParams): Describes the file resource to create.

Raises:

APIException: If API call fails.

Returns:

FileParams: Created file resource params.

static delete(params: FileParams) → None

Delete an existing file resource.

Args:

params (FileParams): Describes the file to delete.

Raises:

Exception: FileParams.file_id was not defined.

APIException: If API call fails.

Returns:

FileParams: Read file resource.

static read(params: FileParams) → FileParams

Read an existing file resource.

Args:

params (FileParams): Describes the file resource to read.

Raises:

Exception: FileParams.file_id was not defined.

APIException: If API call fails.

Returns:

FileParams: Read file resource params.

static read_all(query_params: QueryParams | None = None) → PagedResponse

Read all files in project.

Args:

query_params (QueryParams, optional): Describes query parameters.

Raises:

APIException: If API call fails.

Returns:

PagedResponse: Paged response of file resources.

static route(file_id: int | None = None) → str

Build file resource url route.

Args:

file_id (int, optional): File resource id. Defaults to None. If omitted the route will point to all file resources

Returns:

str: Route to file resource.

static update(params: FileParams) → FileParams

Update an existing file resource.

Args:

params (FileParams): Describes the file and the changes to apply.

Raises:

Exception: FileParams.file_id was not defined.

APIException: If API call fails.

Returns:

FileParams: Read file resource.

class loadero_python.resources.file.FileFilterKey(value)

Bases: FilterKey

FileFilterKey is an enum of all filter keys for file read all API operation.

FILE_TYPE = 'filter_file_type'

class loadero_python.resources.file.FileParams(file_id: int | None = None, file_type: FileType | None = None, content: str | None = None, password: str | None = None, name: str | None = None)

Bases: LoaderoResourceParams

FileParams describes single Loadero file resources attributes.

property created: datetime

Time when file was created.

Returns:

datetime: Time when resource was created.

property updated: datetime

Time when file was last updated.

Returns:

datetime: Time when file was last updated.