Coverage for src/braket/task_result/additional_metadata.py : 100%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# Copyright 2019-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License"). You
4# may not use this file except in compliance with the License. A copy of
5# the License is located at
6#
7# http://aws.amazon.com/apache2.0/
8#
9# or in the "license" file accompanying this file. This file is
10# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11# ANY KIND, either express or implied. See the License for the specific
12# language governing permissions and limitations under the License
14from typing import Optional, Union
16from pydantic import BaseModel
18from braket.ir.annealing import Problem
19from braket.ir.jaqcd import Program
20from braket.task_result.dwave_metadata_v1 import DwaveMetadata
21from braket.task_result.rigetti_metadata_v1 import RigettiMetadata
24class AdditionalMetadata(BaseModel):
25 """
26 The additional metadata result schema.
28 Attributes:
29 action (Union[Program, Problem]): The action of the task
30 dWaveMetadata (DWaveMetadata): Additional metadata for tasks that ran on D-Wave.
31 Default is None.
33 Examples:
34 >>> AdditionalMetadata(action=Program(instructions=[CNot(control=0, target=1)]))
36 """
38 action: Union[Program, Problem]
39 dwaveMetadata: Optional[DwaveMetadata]
40 rigettiMetadata: Optional[RigettiMetadata]