braket.task_result.program_set_task_metadata_v1 module

class braket.task_result.program_set_task_metadata_v1.ProgramMetadata(*, executables: list[ProgramSetExecutableFailureMetadata | ProgramSetExecutableResultMetadata | ProgramSetExecutableCancellationMetadata])[source]

Bases: BaseModel

Metadata about the program

executables (list[Union[ProgramSetExecutableFailureMetadata,: ProgramSetExecutableResultMetadata, ProgramSetExecutableCancellationMetadata]]): The parameter-injected programs associated with this program source

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.

executables: list[ProgramSetExecutableFailureMetadata | ProgramSetExecutableResultMetadata | ProgramSetExecutableCancellationMetadata]

class braket.task_result.program_set_task_metadata_v1.ProgramSetTaskMetadata(*, braketSchemaHeader: BraketSchemaHeader = BraketSchemaHeader(name='braket.task_result.program_set_task_metadata', version='1'), id: ConstrainedStrValue, deviceId: ConstrainedStrValue, requestedShots: ConstrainedIntValue, successfulShots: ConstrainedIntValue, programMetadata: list[ProgramMetadata], deviceParameters: GateModelSimulatorDeviceParameters | IonqDeviceParameters | IqmDeviceParameters | RigettiDeviceParameters | GateModelDeviceParameters | None = None, createdAt: ConstrainedStrValue | None = None, endedAt: ConstrainedStrValue | None = None, status: ConstrainedStrValue | None = None, totalFailedExecutables: int)[source]

Bases: BraketSchemaBase

The program set task metadata schema.

id

The ID of the task. For AWS tasks, this is the task ARN.

Type:: str

requestedShots

The total number of shots for each executable.

Type:: int

successfulShots

The total number of shots across all completed executables

Type:: int

programMetadata

The metadata of the source program

Type:: list[ProgramMetadata]

deviceId

The ID of the device on which the task ran. For AWS devices, this is the device ARN.

Type:: str

deviceParameters (Union[GateModelSimulatorDeviceParameters, IonqDeviceParameters,: IqmDeviceParameters, RigettiDeviceParameters]):

The device parameters of the task. Default is None.

createdAt

The timestamp of task creation in ISO-8601/RFC3339 string format (YYYY-MM-DDTHH:mm:ss.sssZ)

Type:: str

endedAt

The timestamp of when the task ended in ISO-8601/RFC3339 string format (YYYY-MM-DDTHH:mm:ss.sssZ). Default is None.

Type:: str

status

The status of the task. Default is None.

Type:: str

totalFailedExecutables

The number of failed executables in the batch.

Type:: int

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.

braketSchemaHeader: BraketSchemaHeader

id: ConstrainedStrValue

deviceId: ConstrainedStrValue

requestedShots: ConstrainedIntValue

successfulShots: ConstrainedIntValue

programMetadata: list[ProgramMetadata]

deviceParameters: GateModelSimulatorDeviceParameters | IonqDeviceParameters | IqmDeviceParameters | RigettiDeviceParameters | GateModelDeviceParameters | None

createdAt: ConstrainedStrValue | None

endedAt: ConstrainedStrValue | None

status: ConstrainedStrValue | None

totalFailedExecutables: int