Class: QgsStacCollectionList

Class for storing a list of STAC Collections, which is typically used to store the data returned by STAC API /collections endpoint.

Added in version 3.44.

class qgis.core.QgsStacCollectionList[source]

Bases: object

__init__(collections: Iterable[QgsStacCollection], links: Iterable[QgsStacLink], numberMatched: int = -1)

Constructs a valid list of collections,

Parameters:

  • collections (Iterable[QgsStacCollection]) – The STAC Collections to be stored, ownership is transferred

  • links (Iterable[QgsStacLink]) – A list of references to other documents.

  • numberMatched (int = -1) – The total number of collections in the parent catalog, collection or total matching results from a STAC API endpoint

Note

ownership of collections is transferred. Collections will be deleted when object is destroyed.

__init__(a0: QgsStacCollectionList)
Parameters:

a0 (QgsStacCollectionList)

collections(self) → List[QgsStacCollection]

Returns the collections Ownership is not transferred

Return type:

List[QgsStacCollection]

nextUrl(self) → QUrl[source]

Returns the url of the collections’ “next” link

Return type:

QUrl

numberMatched(self) → int[source]

Returns the total number of available collections If this information was not available by the STAC server, -1 is returned

Return type:

int

numberReturned(self) → int[source]

Returns the number of returned collections

Return type:

int

prevUrl(self) → QUrl[source]

Returns the url of the collections’ “prev” link

Return type:

QUrl

rootUrl(self) → QUrl[source]

Returns the url of the collections’ “root” link

Return type:

QUrl

takeCollections(self) → List[QgsStacCollection]

Returns the collections Caller takes ownership of the returned collections

Return type:

List[QgsStacCollection]

url(self) → QUrl[source]

Returns the url of the collections’ “self” link

Return type:

QUrl