eodag.plugins.apis.cds.CdsApi

class eodag.plugins.apis.cds.CdsApi(provider: str, config: PluginConfig)

A plugin that enables to build download-request and download data on CDS API.

Builds a single ready-to-download EOProduct during the search stage.

This class inherits from Api for compatibility, Download for download methods, and QueryStringSearch for metadata-mapping and query build methods.

__init__(provider: str, config: PluginConfig) → None

Methods

__init__(provider, config)
authenticate()	Returns information needed for auth
build_query_string(product_type, **kwargs)	Build The query string using the search parameters
clear()	Method used to clear a search context between two searches.
collect_search_urls([page, items_per_page, ...])	Wraps PostJsonSearch.collect_search_urls to force product count to 1
count_hits([count_url, result_type])	Count method that will always return 1.
discover_product_types()	Fetch product types list from provider using discover_product_types conf
discover_queryables(**kwargs)	Fetch queryables list from provider using discover_queryables conf
do_search(*args, **kwargs)	Should perform the actual search request.
download(product[, auth, progress_callback, ...])	Download data from providers using CDS API
download_all(products[, auth, ...])	Download all using parent (base plugin) method
get_collections(**kwargs)	Get the collection to which the product belongs
get_defaults_as_queryables(product_type)	Return given product type defaut settings as queryables
get_metadata_mapping([product_type])	Get the plugin metadata mapping configuration (product type specific if exists)
get_product_type_cfg(key[, default])	Get the value of a configuration option specific to the current product type.
get_product_type_def_params(product_type, ...)	Get the provider product type definition parameters and specific settings
map_product_type(product_type, **kwargs)	Get the provider product type from eodag product type
normalize_results(results, **kwargs)	Build EOProduct from provider result
orderDownload(product[, auth])	Send product order request.
orderDownloadStatus(product[, auth])	Send product order status request.
query([product_type, items_per_page, page, ...])	Build ready-to-download SearchResult
update_metadata_mapping(metadata_mapping)	Update plugin metadata_mapping with input metadata_mapping configuration

Attributes

DEFAULT_ITEMS_PER_PAGE
extract_properties
plugins