Table of Contents

openeo_fastapi.client.collections

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

Classes: - CollectionRegister: Framework for defining and extending the logic for working with Collections.

CollectionRegister Objects

class CollectionRegister(EndpointRegister)

The CollectionRegister to regulate the application logic for the API behaviour.

__init__

def __init__(settings) -> None

Initialize the CollectionRegister.

Arguments:

  • settings AppSettings - The AppSettings that the application will use.

get_collection

async def get_collection(collection_id)

Returns Metadata for specific datasetsbased on collection_id (str).

Arguments:

  • collection_id str - The collection id to request from the proxy.

Raises:

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

Returns:

  • Collection - The proxied request returned as a Collection.

get_collections

async def get_collections()

Returns Basic metadata for all datasets

Raises:

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

Returns:

  • Collections - The proxied request returned as a Collections object.

get_collection_items

async def get_collection_items(collection_id)

Returns Basic metadata for all datasets.

Arguments:

  • collection_id str - The collection id to request from the proxy.

Raises:

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

Returns:

The direct response from the request to the stac catalogue.

get_collection_item

async def get_collection_item(collection_id, item_id)

Returns Basic metadata for all datasets

Arguments:

  • collection_id str - The collection id to request from the proxy.
  • item_id str - The item id to request from the proxy.

Raises:

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

Returns:

The direct response from the request to the stac catalogue.