extraction_methods.plugins.assets package

Subpackages

extraction_methods.plugins.assets.backends package

Submodules

extraction_methods.plugins.assets.assets module

STAC Assets Extraction

class extraction_methods.plugins.assets.assets.AssetExtract(*args: Any, **kwargs: Any)

Bases: SetEntryPointsMixin, ExtractionMethod

Method: assets

Description:: Method to generate a dictionary of STAC Assets.

Configuration Options: .. list-table:

- ``backend``: Backend name and inputs
- ``extraction_methods``: Extraction methods to run on assets
- ``output_key``: key to output to

Configuration Example: .. code-block:: yaml

method: assets inputs:

backend:
name: elasticsearch inputs:

connection_kwargs:
hosts: [‘host1:9200’,’host2:9200’]

extraction_methods:

method: default inputs:

defaults:
hello: world

entry_point_group: str = 'extraction_methods.assets.backends'

input_class: alias of AssetInput

run(body: dict[str, Any]) → Any

Run the method.

Parameters:: body (dict) – current generated properties
Returns:: updated body dict
Return type:: dict

class extraction_methods.plugins.assets.assets.AssetInput(*, exists_key: str = '$', exists_delimiter: str = '.', backend: Backend, extraction_methods: list[Any] = [], output_key: str = 'assets')

Bases: Input

Model for Asset Method Input.

backend: Backend

extraction_methods: list[Any]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'backend': FieldInfo(annotation=Backend, required=True, description='Backend and inputs to run.'), 'exists_delimiter': FieldInfo(annotation=str, required=False, default='.', description='Delimiter for nested exists terms.'), 'exists_key': FieldInfo(annotation=str, required=False, default='$', description='Key to signify a previously extracted terms.'), 'extraction_methods': FieldInfo(annotation=list[Any], required=False, default=[], description='Extraction methods to run on assets.'), 'output_key': FieldInfo(annotation=str, required=False, default='assets', description='term for method to output to.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

output_key: str

Module contents

Asset Extract

class extraction_methods.plugins.assets.AssetExtract(*args: Any, **kwargs: Any)