CopMarineSearch

CopMarineSearch#

class eodag.plugins.search.cop_marine.CopMarineSearch(provider, config)[source]#

class that implements search for the Copernicus Marine provider

It calls discover_product_types() inherited from StaticStacSearch but for the actual search a special method which fetches the urls of the available products from an S3 storage and filters them has been written.

The configuration parameters are inherited from the parent and grand-parent classes. The auto_discovery parameter in the discover_metadata section has to be set to false and the fetch_url in the discover_queryables queryables section has to be set to null to overwrite the default config from the stac provider configuration because those functionalities are not available.

Parameters:
__init__(provider, config)[source]#
Parameters:

Methods

__init__(provider, config)

build_query_string(product_type, query_dict)

Build The query string using the search parameters

build_sort_by(sort_by_arg)

Build the sorting part of the query string or body by transforming the sort_by argument into a provider-specific string or dictionary

clear()

Clear search context

collect_search_urls([prep])

Adds pagination to query parameters, and auth to url

count_hits(count_url[, result_type])

Count the number of results satisfying some criteria

discover_product_types(**kwargs)

Fetch product types list from a static STAC Catalog provider using discover_product_types conf

discover_product_types_per_page(**kwargs)

Fetch product types list from provider using discover_product_types conf using paginated kwargs["fetch_url"]

discover_queryables(**kwargs)

Set static available queryables for StaticStacSearch search plugin

do_search([prep])

Perform the actual search request.

get_assets_from_mapping(provider_item)

Create assets based on the assets_mapping in the provider's config and an item returned by the provider

get_collections(prep, **kwargs)

Get the collection to which the product belongs

get_metadata_mapping([product_type])

Get the plugin metadata mapping configuration (product type specific if exists)

get_product_type_cfg_value(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

get_sort_by_arg(kwargs)

Extract the sort_by argument from the kwargs or the provider default sort configuration

list_queryables(filters, ...[, ...])

Get queryables

map_product_type(product_type, **kwargs)

Get the provider product type from eodag product type

normalize_results(results, **kwargs)

Build EOProducts from provider results

query([prep])

Implementation of search for the Copernicus Marine provider :type prep: PreparedSearch, default: PreparedSearch(product_type=None, page=1, items_per_page=20, auth=None, auth_plugin=None, count=True, url=None, info_message=None, exception_message=None) :param prep: object containing search parameterds :type kwargs: Any :param kwargs: additional search arguments :rtype: tuple[list[EOProduct], int | None] :returns: list of products and total number of products

queryables_from_metadata_mapping([...])

Extract queryable parameters from product type metadata mapping.

validate(search_params, auth)

Validate a search request.

Attributes

extract_properties

plugins

auth

next_page_url

next_page_query_obj

total_items_nb

need_count

Contents