Table of Contents

• openeo_fastapi.client.files
• FilesRegister
  • list_files
  • download_file
  • upload_file
  • delete_file

openeo_fastapi.client.files

Class and model to define the framework and partial application logic for interacting with Files.

Classes: - FilesRegister: Framework for defining and extending the logic for working with Files.

FilesRegister Objects

class FilesRegister(EndpointRegister)

list_files

def list_files(limit: Optional[int] = 10,
               user: User = Depends(Authenticator.validate))

List the files in the user workspace.

Arguments:

• limit int - The limit to apply to the length of the list.
• user User - The User returned from the Authenticator.

Raises:

• HTTPException - Raises an exception with relevant status code and descriptive message of failure.

download_file

def download_file(path: str, user: User = Depends(Authenticator.validate))

Download the file from the user's workspace.

Arguments:

• path str - The path leading to the file.
• user User - The User returned from the Authenticator.

Raises:

• HTTPException - Raises an exception with relevant status code and descriptive message of failure.

upload_file

def upload_file(path: str, user: User = Depends(Authenticator.validate))

Upload the file from the user's workspace.

Arguments:

• path str - The path leading to the file.
• user User - The User returned from the Authenticator.

Raises:

• HTTPException - Raises an exception with relevant status code and descriptive message of failure.

delete_file

def delete_file(path: str, user: User = Depends(Authenticator.validate))

Delete the file from the user's workspace.

Arguments:

• path str - The path leading to the file.
• user User - The User returned from the Authenticator.

Raises:

• HTTPException - Raises an exception with relevant status code and descriptive message of failure.