client

stac_fastapi.extensions.core.collection_search.client

collection-search extensions clients.

AsyncBaseCollectionSearchClient

Bases: ABC

Defines a pattern for implementing the STAC collection-search POST extension.

Source code in stac_fastapi/extensions/core/collection_search/client.py

@attr.s
class AsyncBaseCollectionSearchClient(abc.ABC):
    """Defines a pattern for implementing the STAC collection-search POST extension."""

    @abc.abstractmethod
    async def post_all_collections(
        self,
        search_request: BaseCollectionSearchPostRequest,
        **kwargs,
    ) -> stac.ItemCollection:
        """Get all available collections.

        Called with `POST /collections`.

        Returns:
            A list of collections.

        """
        ...

post_all_collections abstractmethod async

post_all_collections(search_request: BaseCollectionSearchPostRequest, **kwargs) -> ItemCollection

Get all available collections.

Called with POST /collections.

Returns:

• ItemCollection –

  A list of collections.

Source code in stac_fastapi/extensions/core/collection_search/client.py

@abc.abstractmethod
async def post_all_collections(
    self,
    search_request: BaseCollectionSearchPostRequest,
    **kwargs,
) -> stac.ItemCollection:
    """Get all available collections.

    Called with `POST /collections`.

    Returns:
        A list of collections.

    """
    ...

BaseCollectionSearchClient

Bases: ABC

Defines a pattern for implementing the STAC collection-search POST extension.

Source code in stac_fastapi/extensions/core/collection_search/client.py

@attr.s
class BaseCollectionSearchClient(abc.ABC):
    """Defines a pattern for implementing the STAC collection-search POST extension."""

    @abc.abstractmethod
    def post_all_collections(
        self, search_request: BaseCollectionSearchPostRequest, **kwargs
    ) -> stac.ItemCollection:
        """Get all available collections.

        Called with `POST /collections`.

        Returns:
            A list of collections.

        """
        ...

post_all_collections abstractmethod

post_all_collections(search_request: BaseCollectionSearchPostRequest, **kwargs) -> ItemCollection

Get all available collections.

Called with POST /collections.

Returns:

• ItemCollection –

  A list of collections.

Source code in stac_fastapi/extensions/core/collection_search/client.py

@abc.abstractmethod
def post_all_collections(
    self, search_request: BaseCollectionSearchPostRequest, **kwargs
) -> stac.ItemCollection:
    """Get all available collections.

    Called with `POST /collections`.

    Returns:
        A list of collections.

    """
    ...