Class: QgsStacCatalog

Class for storing a STAC Catalog’s data.

Added in version 3.44.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsStacObject

Abstract base class for storing STAC objects.

Subclasses

QgsStacCollection

Class for storing a STAC Collection’s data.

Methods

addConformanceClass	Adds conformanceClass to the list of catalog's conformance classes
conformsTo	Checks if the catalog is a STAC API conforming to the specified conformanceClass
description	Returns a Detailed multi-line description to fully explain the Catalog.
setConformanceClasses	Sets the list of conformanceClasses this catalog conforms to.
setDescription	Sets a detailed multi-line description to fully explain the Catalog.
setTitle	Sets a short descriptive one-line title for the Catalog.
title	Returns a short descriptive one-line title for the Catalog.

class qgis.core.QgsStacCatalog

Bases: QgsStacObject

__init__(id: str | None, version: str | None, description: str | None, links: Iterable[QgsStacLink])

Constructs a valid QgsStacCatalog

Parameters:

• id (Optional[str]) – A unique identifier for the catalog

• version (Optional[str]) – The STAC version the Catalog implements.

• description (Optional[str]) – Detailed multi-line description to fully explain the Catalog. CommonMark 0.29 syntax may be used for rich text representation.

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

__init__(a0: QgsStacCatalog)

Parameters:

a0 (QgsStacCatalog)

addConformanceClass(self, conformanceClass: str | None)

Adds conformanceClass to the list of catalog’s conformance classes

Parameters:

conformanceClass (Optional[str])

conformsTo(self, conformanceClass: str | None) → bool

Checks if the catalog is a STAC API conforming to the specified conformanceClass

Parameters:

conformanceClass (Optional[str])

Return type:

bool

description(self) → str

Returns a Detailed multi-line description to fully explain the Catalog. CommonMark 0.29 syntax may be used for rich text representation.

Return type:

str

setConformanceClasses(self, conformanceClasses: Iterable[str | None])

Sets the list of conformanceClasses this catalog conforms to.

Parameters:

conformanceClasses (Iterable[Optional[str]])

setDescription(self, description: str | None)

Sets a detailed multi-line description to fully explain the Catalog. CommonMark 0.29 syntax may be used for rich text representation.

Parameters:

description (Optional[str])

setTitle(self, title: str | None)

Sets a short descriptive one-line title for the Catalog.

Parameters:

title (Optional[str])

title(self) → str

Returns a short descriptive one-line title for the Catalog.

Return type:

str