braket.schema_common.schema_header module

class braket.schema_common.schema_header.BraketSchemaHeader

Bases: pydantic.main.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.

get_module_name()

get_package_name()

import_schema_module()

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