apache_airflow_providers_imednet package

class apache_airflow_providers_imednet.ImednetExportOperator[source]

Bases: BaseOperator

Export study records using helpers from imednet.integrations.export.

__init__(*, study_key, output_path, export_func='export_to_csv', export_kwargs=None, imednet_conn_id='imednet_default', **kwargs)[source]
Parameters:

  • study_key (str) –

  • output_path (str) –

  • export_func (str) –

  • export_kwargs (Mapping[str, Any] | None) –

  • imednet_conn_id (str) –

  • kwargs (Any) –

Return type:

None

execute(context)[source]
Return type:

str

Parameters:

context (airflow.sdk.Context) –

mapped_runtime_fields: Sequence[str] = ('study_key', 'output_path', 'export_kwargs')
template_fields: Sequence[str] = ('study_key', 'output_path', 'export_kwargs')
template_fields_renderers = {'export_kwargs': 'json'}
class apache_airflow_providers_imednet.ImednetHook[source]

Bases: BaseHook

Retrieve an ImednetSDK instance from an Airflow connection.

__init__(imednet_conn_id='imednet_default')[source]
Parameters:

imednet_conn_id (str) –

Return type:

None

describe_connection()[source]

Return redacted primitive metadata about resolved hook configuration.

Return type:

Dict[str, Union[str, int, float, bool, None, List[Union[str, int, float, bool, None, List[PrimitiveContainer], Dict[str, PrimitiveContainer]]], Dict[str, Union[str, int, float, bool, None, List[PrimitiveContainer], Dict[str, PrimitiveContainer]]]]]

get_conn()[source]

Backward compatible alias for get_sdk_client().

Return type:

ImednetSDK

get_sdk_client()[source]

Return an SDK client for use within task execution context.

Return type:

ImednetSDK

list_studies_metadata()[source]

Return primitive, serialization-safe study metadata for task mapping.

Return type:

List[Dict[str, Union[str, int, float, bool, None, List[Union[str, int, float, bool, None, List[PrimitiveContainer], Dict[str, PrimitiveContainer]]], Dict[str, Union[str, int, float, bool, None, List[PrimitiveContainer], Dict[str, PrimitiveContainer]]]]]]

list_study_keys()[source]

Return primitive study keys for mapped Airflow task expansion.

Return type:

List[str]

class apache_airflow_providers_imednet.ImednetJobSensor[source]

Bases: BaseSensorOperator

Poll iMednet for job completion.

__init__(*, study_key, batch_id, imednet_conn_id='imednet_default', poke_interval=60, **kwargs)[source]
Parameters:

  • study_key (str) –

  • batch_id (str) –

  • imednet_conn_id (str) –

  • poke_interval (float) –

  • kwargs (Any) –

Return type:

None

poke(context)[source]
Return type:

bool

Parameters:

context (airflow.sdk.Context) –

template_fields: Sequence[str] = ('study_key', 'batch_id')
class apache_airflow_providers_imednet.ImednetToS3Operator[source]

Bases: BaseOperator

Fetch data from iMednet and store it in S3 as JSON.

__init__(*, study_key, s3_bucket, s3_key, endpoint='records', endpoint_kwargs=None, imednet_conn_id='imednet_default', aws_conn_id='aws_default', **kwargs)[source]
Parameters:

  • study_key (str) –

  • s3_bucket (str) –

  • s3_key (str) –

  • endpoint (str) –

  • endpoint_kwargs (Dict[str, Any] | None) –

  • imednet_conn_id (str) –

  • aws_conn_id (str) –

  • kwargs (Any) –

Return type:

None

execute(context)[source]
Return type:

str

Parameters:

context (airflow.sdk.Context) –

template_fields: Sequence[str] = ('study_key', 's3_key')

Subpackages

Submodules

apache_airflow_providers_imednet.export module

Airflow-facing export helpers.

apache_airflow_providers_imednet.export.export_to_csv(*args, **kwargs)[source]
Return type:

None

Parameters:

  • args (Any) –

  • kwargs (Any) –

apache_airflow_providers_imednet.export.export_to_excel(*args, **kwargs)[source]
Return type:

None

Parameters:

  • args (Any) –

  • kwargs (Any) –

apache_airflow_providers_imednet.export.export_to_json(*args, **kwargs)[source]
Return type:

None

Parameters:

  • args (Any) –

  • kwargs (Any) –

apache_airflow_providers_imednet.export.export_to_parquet(*args, **kwargs)[source]
Return type:

None

Parameters:

  • args (Any) –

  • kwargs (Any) –

apache_airflow_providers_imednet.export.export_to_sql(*args, **kwargs)[source]
Return type:

None

Parameters:

  • args (Any) –

  • kwargs (Any) –

apache_airflow_providers_imednet.export.export_to_sql_by_form(*args, **kwargs)[source]
Return type:

None

Parameters:

  • args (Any) –

  • kwargs (Any) –

apache_airflow_providers_imednet.sensors module

Airflow sensors for iMednet operations.

class apache_airflow_providers_imednet.sensors.ImednetJobSensor[source]

Bases: BaseSensorOperator

Poll iMednet for job completion.

__init__(*, study_key, batch_id, imednet_conn_id='imednet_default', poke_interval=60, **kwargs)[source]
Parameters:

  • study_key (str) –

  • batch_id (str) –

  • imednet_conn_id (str) –

  • poke_interval (float) –

  • kwargs (Any) –

Return type:

None

poke(context)[source]
Return type:

bool

Parameters:

context (airflow.sdk.Context) –

template_fields: Sequence[str] = ('study_key', 'batch_id')