braket.device_schema.pulse.pulse_function_v1 module

class braket.device_schema.pulse.pulse_function_v1.PulseFunctionArgument(*, name: str, type: str, optional: bool = False, description: str | None = None)[source]

Bases: BaseModel

Defines a pulse function argument

name

The argument name

Type:: str

type

The string name of the argument type

Type:: str

description

Optional description for the argument

Type:: str | None

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: str

type: str

optional: bool

description: str | None

class braket.device_schema.pulse.pulse_function_v1.PulseFunction(*, functionName: str, arguments: List[PulseFunctionArgument], returnType: str | None = None)[source]

Bases: BaseModel

Describes a pulse function

functionName

The name of the function

Type:: str

arguments

List of function arguments

Type:: List[braket.device_schema.pulse.pulse_function_v1.PulseFunctionArgument]

returnType

Return type of the function. If null function has no return value.

Type:: str | None

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.

functionName: str

arguments: List[PulseFunctionArgument]

returnType: str | None