citrine.gemd_queries.gemd_query module

Definitions for GemdQuery objects, and their sub-objects.

class citrine.gemd_queries.gemd_query.GemdObjectType(value)

Bases: BaseEnumeration

The style of text search to run.

CONDITION_TEMPLATE_TYPE = 'condition_template'

INGREDIENT_RUN_TYPE = 'ingredient_run'

INGREDIENT_SPEC_TYPE = 'ingredient_spec'

MATERIAL_RUN_TYPE = 'material_run'

MATERIAL_SPEC_TYPE = 'material_spec'

MATERIAL_TEMPLATE_TYPE = 'material_template'

MEASUREMENT_RUN_TYPE = 'measurement_run'

MEASUREMENT_SPEC_TYPE = 'measurement_spec'

MEASUREMENT_TEMPLATE_TYPE = 'measurement_template'

PARAMETER_TEMPLATE_TYPE = 'parameter_template'

PROCESS_RUN_TYPE = 'process_run'

PROCESS_SPEC_TYPE = 'process_spec'

PROCESS_TEMPLATE_TYPE = 'process_template'

PROPERTY_TEMPLATE_TYPE = 'property_template'

class citrine.gemd_queries.gemd_query.GemdQuery

Bases: Serializable[GemdQuery]

This describes what data objects to fetch (or graph of data objects).

Parameters:

criteria (Criteria) – List of conditions all responses must satisfy (i.e., joined with an AND).
datasets (UUID) – Set of datasets to look in for matching objects.
object_types (GemdObjectType) – Classes of objects to consider when searching.
schema_version (Int) – What version of the query schema this package represents.

classmethod build(data: dict) → Self: Build an instance of this object from given data.

dump() → dict: Dump this instance.

criteria = []

datasets = {}

object_types = {GemdObjectType.CONDITION_TEMPLATE_TYPE, GemdObjectType.INGREDIENT_RUN_TYPE, GemdObjectType.INGREDIENT_SPEC_TYPE, GemdObjectType.MATERIAL_RUN_TYPE, GemdObjectType.MATERIAL_SPEC_TYPE, GemdObjectType.MATERIAL_TEMPLATE_TYPE, GemdObjectType.MEASUREMENT_RUN_TYPE, GemdObjectType.MEASUREMENT_SPEC_TYPE, GemdObjectType.MEASUREMENT_TEMPLATE_TYPE, GemdObjectType.PARAMETER_TEMPLATE_TYPE, GemdObjectType.PROCESS_RUN_TYPE, GemdObjectType.PROCESS_SPEC_TYPE, GemdObjectType.PROCESS_TEMPLATE_TYPE, GemdObjectType.PROPERTY_TEMPLATE_TYPE}

schema_version = 1