braket.schema_common.schema_header module

class braket.schema_common.schema_header.BraketSchemaHeader(*, name: ConstrainedStrValue, version: ConstrainedStrValue)[source]

Bases: BaseModel

BraketSchemaHeader which dictates the schema and the version.

name

name of the schema

Type:

str

version

version of the schema

Type:

str

Examples

>>> BraketSchemaHeader(name="braket.task_result.annealing_task_result", version="1.0")

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

name: ConstrainedStrValue
version: ConstrainedStrValue
get_module_name()[source]
get_package_name()[source]
import_schema_module()[source]

Imports the module that holds the schema given by the header

Returns:

Module of the corresponding schema

Raises:
  • ModuleNotFoundError – If the schema module cannot be found according to

  • schema header